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 |
|---|---|---|---|---|---|---|---|---|
loft-sh/vcluster | aac1e31b9966c5a6178423bb662d0c592b920594 | 2024-05-22T13:37:41 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths.",
"pro": true
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"enableServiceLinks": {
"description": "EnableServiceLinks for the StatefulSet pod",
"type": "boolean"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName specifies the priority class name for the CoreDNS pods.",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableAutoSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster",
"pro": true
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enableServiceLinks": {
"description": "EnableServiceLinks for the StatefulSet pod",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"pro": true,
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"pro": true,
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"registry": {
"description": "Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally\noverridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.",
"type": "string"
},
"repository": {
"description": "Repository is the repository of the container image, e.g. my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/PlatformAPI",
"description": "API defines how vCluster can contact the platform api."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPI": {
"additionalProperties": false,
"properties": {
"accessKey": {
"description": "AccessKey specifies the access key as a regular text value.",
"type": "string"
},
"host": {
"description": "Host specifies the platform host to use.",
"type": "string"
},
"insecure": {
"description": "Insecure specifies if the host uses a self-signed certificate.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/PlatformAccessKeySecretReference",
"description": "SecretRef defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:\n* platform.api.accessKey\n* environment variable called LICENSE\n* secret specified under platform.api.secretRef.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
}
},
"type": "object"
},
"PlatformAccessKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAccessKeySecretReference defines where to find the platform access key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"registry": {
"description": "Configure the registry of the container image, e.g. my-registry.com or ghcr.io\nIt defaults to ghcr.io and can be overriding either by using this field or controlPlane.advanced.defaultImageRegistry",
"type": "string"
},
"repository": {
"description": "Configure the repository of the container image, e.g. my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiNodes": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainer": {
"$ref": "#/$defs/SyncRewriteHostsInitContainer",
"description": "InitContainer holds extra options for the init container used by vCluster to rewrite the FQDN for stateful set pods."
}
},
"type": "object"
},
"SyncRewriteHostsInitContainer": {
"additionalProperties": false,
"properties": {
"image": {
"description": "Image is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resources that should be assigned to the init container for each stateful set init container."
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | ff9968c6ec8d7674fc6f23d1dd46e0c07aa61b20 | 2024-04-03T12:25:14 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster"
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will fallback to the default distro backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything coredns related."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": true,
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods are additional labels or annotations for the statefulSet pod."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format. This is optional for the embedded database.",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.\n+optional",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.\n+optional",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the scheduler."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.virtualScheduler.enabled"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"localManagerMetricsBindAddress": {
"description": "LocalManagerMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualManagerMetricsBindAddress": {
"description": "VirtualManagerMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"$ref": "#/$defs/ScopeSelector",
"description": "ScopeSelector is the resource quota scope selector"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional",
"type": "string"
}
},
"type": "object"
},
"ScopeSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 9cdaba6b0cae5755e051d63940ce7616d2e8ee20 | 2024-05-16T11:47:27 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths.",
"pro": true
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName specifies the priority class name for the CoreDNS pods.",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableAutoSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster",
"pro": true
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"pro": true,
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"pro": true,
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"registry": {
"description": "Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally\noverridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.",
"type": "string"
},
"repository": {
"description": "Repository is the repository of the container image, e.g. my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/PlatformAPI",
"description": "API defines how vCluster can contact the platform api."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPI": {
"additionalProperties": false,
"properties": {
"accessKey": {
"description": "AccessKey specifies the access key as a regular text value.",
"type": "string"
},
"host": {
"description": "Host specifies the platform host to use.",
"type": "string"
},
"insecure": {
"description": "Insecure specifies if the host uses a self-signed certificate.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/PlatformAccessKeySecretReference",
"description": "SecretRef defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:\n* platform.api.accessKey\n* environment variable called LICENSE\n* secret specified under platform.api.secretRef.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
}
},
"type": "object"
},
"PlatformAccessKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAccessKeySecretReference defines where to find the platform access key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"registry": {
"description": "Configure the registry of the container image, e.g. my-registry.com or ghcr.io\nIt defaults to ghcr.io and can be overriding either by using this field or controlPlane.advanced.defaultImageRegistry",
"type": "string"
},
"repository": {
"description": "Configure the repository of the container image, e.g. my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiNodes": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainer": {
"$ref": "#/$defs/SyncRewriteHostsInitContainer",
"description": "InitContainer holds extra options for the init container used by vCluster to rewrite the FQDN for stateful set pods."
}
},
"type": "object"
},
"SyncRewriteHostsInitContainer": {
"additionalProperties": false,
"properties": {
"image": {
"description": "Image is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resources that should be assigned to the init container for each stateful set init container."
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 97e03b9d47ee043ee2389f8a9fa344499027dd71 | 2024-04-02T05:43:49 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster"
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": true,
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will fallback to the default distro backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything coredns related."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": true,
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods are additional labels or annotations for the statefulSet pod."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embeddedSqlite": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format. This is optional for the embedded database.",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.\n+optional",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.\n+optional",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the scheduler."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.virtualScheduler.enabled"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"$ref": "#/$defs/ScopeSelector",
"description": "ScopeSelector is the resource quota scope selector"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional",
"type": "string"
}
},
"type": "object"
},
"ScopeSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 432f21c73abd85a9166212ff7ec966b63871cef8 | 2024-05-07T14:57:02 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths.",
"pro": true
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableAutoSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster",
"pro": true
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"pro": true,
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"pro": true,
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"registry": {
"description": "Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally\noverridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.",
"type": "string"
},
"repository": {
"description": "Repository is the repository of the container image, e.g. my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"api": {
"$ref": "#/$defs/PlatformAPI",
"description": "API defines how vCluster can contact the platform api."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPI": {
"additionalProperties": false,
"properties": {
"accessKey": {
"description": "AccessKey specifies the access key as a regular text value.",
"type": "string"
},
"host": {
"description": "Host specifies the platform host to use.",
"type": "string"
},
"insecure": {
"description": "Insecure specifies if the host uses a self-signed certificate.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/$defs/PlatformAccessKeySecretReference",
"description": "SecretRef defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:\n* platform.api.accessKey\n* environment variable called LICENSE\n* secret specified under platform.api.secretRef.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
}
},
"type": "object"
},
"PlatformAccessKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAccessKeySecretReference defines where to find the platform access key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"registry": {
"description": "Configure the registry of the container image, e.g. my-registry.com or ghcr.io\nIt defaults to ghcr.io and can be overriding either by using this field or controlPlane.advanced.defaultImageRegistry",
"type": "string"
},
"repository": {
"description": "Configure the repository of the container image, e.g. my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiNodes": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainer": {
"$ref": "#/$defs/SyncRewriteHostsInitContainer",
"description": "InitContainer holds extra options for the init container used by vCluster to rewrite the FQDN for stateful set pods."
}
},
"type": "object"
},
"SyncRewriteHostsInitContainer": {
"additionalProperties": false,
"properties": {
"image": {
"description": "Image is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resources that should be assigned to the init container for each stateful set init container."
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | ebfd1fefd992f366ef360920ae4150c6bc90f4ca | 2024-03-15T13:03:31 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"embeddedEtcd": {
"$ref": "#/$defs/EmbeddedEtcd",
"description": "EmbeddedEtcd defines to use embedded etcd as a storage backend for the vCluster"
},
"externalEtcd": {
"$ref": "#/$defs/ExternalEtcd",
"description": "ExternalEtcd defines to use an external etcd deployed by the helm chart as a storage backend for the vCluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the vCluster",
"items": true,
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the vCluster",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for vCluster. If not defined will fallback to the default distro backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything coredns related."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds vCluster related distro options."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for the vCluster ingress deployed by helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the vCluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for the vCluster service deployed by helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for the vCluster statefulSet deployed by helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster statefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control-plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the vCluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the vCluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which the vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which the vCluster will expose the proxy.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": true,
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods are additional labels or annotations for the statefulSet pod."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the vCluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the vCluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the vCluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.\n+optional",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.\n+optional",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds k3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds k8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerDisabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "Disabled signals this container should be disabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the k3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the k3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerDisabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerDisabled",
"description": "ControllerManager holds configuration specific to starting the scheduler."
},
"enabled": {
"description": "Enabled specifies if the k8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler."
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EmbeddedEtcd": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromExternalEtcd": {
"description": "MigrateFromExternalEtcd signals that vCluster should migrate from the external etcd.",
"type": "boolean"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and helm charts to deploy within the vCluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from vCluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells vCluster to sync to multiple namespaces instead of a single one. This will map each vCluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are helm charts that should get deployed into the vCluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw kubernetes manifests that should get applied within the vCluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a kubernetes manifest template that will be rendered with vCluster values before applying it within the vCluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kube config.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the kubernetes service to point to the vCluster if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from vCluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kube config",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kube config to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Secret defines in which secret in the host cluster the generated kube-config should be stored.\nIf this is not defined, vCluster will only create it at `vc-NAME`. If another name is specified here\nvCluster will also create the config in this other secret."
},
"server": {
"description": "Server can be used to override the default https://localhost:8443 and specify a custom hostname for the\ngenerated kube-config.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "ExportKubeConfigSecretReference defines in which secret in the host cluster the generated kube-config should be stored.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kube config should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the kube config secret should get stored. If this is not equal to the namespace\nwhere the vCluster is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcd": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the external etcd should be used.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/ExternalEtcdHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/ExternalEtcdService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/ExternalEtcdStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"ExternalEtcdHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"ExternalEtcdStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"description": "IPBlock describes a particular CIDR (Ex.",
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to vCluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to vCluster.",
"type": "boolean"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. prometheus requires a node ip.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to vCluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the vCluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the vCluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to vCluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock"
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster should connect to.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra vCluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra vCluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the vCluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds vCluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds vCluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Disabled defines if the cluster role should be disabled. Otherwise, its automatically determined if vCluster requires a cluster role.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the vCluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from vCluster to the host cluster. If services are\nsynced to a different namespace than the vCluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"type": "string"
},
"namespace": {
"type": "string"
},
"service": {
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"type": "string"
},
"ip": {
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"$ref": "#/$defs/ScopeSelector",
"description": "ScopeSelector is the resource quota scope selector"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional",
"type": "string"
}
},
"type": "object"
},
"ScopeSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "FromHost configures what resources should get purely synced from the host cluster to the vCluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "ToHost configures what resources should get synced from the vCluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the vCluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the vCluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the vCluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the vCluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the vCluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the vCluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the vCluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the vCluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to vCluster. This will also set the node selector when syncing a pod from vCluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the vCluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the vCluster to the host cluster. If this is enabled someone within the vCluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the vCluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. vCluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe vCluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the vCluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by vCluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image vCluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the vCluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the vCluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the vCluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the vCluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the vCluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the vCluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the vCluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the vCluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the vCluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the vCluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the vCluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the vCluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the vCluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the vCluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Disabled specifies that the telemetry for vCluster control plane should be disabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kube config path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "Disabled signals to disable deploying a persistent volume claim. If false, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "ControlPlane holds options how to configure the vCluster control-plane"
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental are alpha features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kube config"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking are networking options related to the vCluster"
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the vCluster"
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options how vCluster should connect to vCluster platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies what vCluster plugins to enable. Please use \"plugins\" instead. Please do not use that option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugins define what vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies defines policies to enforce for the vCluster deployment as well as within the vCluster"
},
"pro": {
"description": "Pro specifies if vCluster pro should be used. This is automatically inferred in newer versions. Please do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC are role based access control options for the vCluster"
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the vCluster. Please do not use that option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the vCluster to host cluster and back"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry is the configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 1e65a2905295eb0dae62b5970b083f74264ccee9 | 2024-04-18T13:17:02 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths.",
"pro": true
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableAutoSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster",
"pro": true
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"pro": true,
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"pro": true,
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Configure the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'ghcr.io/loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiNodes": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableAutoSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainer": {
"$ref": "#/$defs/SyncRewriteHostsInitContainer",
"description": "InitContainer holds extra options for the init container used by vCluster to rewrite the FQDN for stateful set pods."
}
},
"type": "object"
},
"SyncRewriteHostsInitContainer": {
"additionalProperties": false,
"properties": {
"image": {
"description": "Image is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resources that should be assigned to the init container for each stateful set init container."
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | ad667145cc036d9c73e419ea090b6324cb2c8b51 | 2024-03-14T15:42:04 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"embeddedEtcd": {
"$ref": "#/$defs/EmbeddedEtcd",
"description": "EmbeddedEtcd defines to use embedded etcd as a storage backend for the vCluster"
},
"externalEtcd": {
"$ref": "#/$defs/ExternalEtcd",
"description": "ExternalEtcd defines to use an external etcd deployed by the helm chart as a storage backend for the vCluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the vCluster",
"items": true,
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the vCluster",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for vCluster. If not defined will fallback to the default distro backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything coredns related."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds vCluster related distro options."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for the vCluster ingress deployed by helm."
},
"observability": {
"$ref": "#/$defs/ControlPlaneObservability",
"description": "Observability defines if a service monitor should get deployed by helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the vCluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for the vCluster service deployed by helm."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for the vCluster statefulSet deployed by helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster statefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control-plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the vCluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the vCluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneObservability": {
"additionalProperties": false,
"properties": {
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which the vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which the vCluster will expose the proxy.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": true,
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods are additional labels or annotations for the statefulSet pod."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the vCluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the vCluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the vCluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds k3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds k8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerDisabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "Disabled signals this container should be disabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the k3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the k3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerDisabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerDisabled",
"description": "ControllerManager holds configuration specific to starting the scheduler."
},
"enabled": {
"description": "Enabled specifies if the k8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler."
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EmbeddedEtcd": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromExternalEtcd": {
"description": "MigrateFromExternalEtcd signals that vCluster should migrate from the external etcd.",
"type": "boolean"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and helm charts to deploy within the vCluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from vCluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells vCluster to sync to multiple namespaces instead of a single one. This will map each vCluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are helm charts that should get deployed into the vCluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw kubernetes manifests that should get applied within the vCluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a kubernetes manifest template that will be rendered with vCluster values before applying it within the vCluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kube config.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the kubernetes service to point to the vCluster if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from vCluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kube config",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kube config to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Secret defines in which secret in the host cluster the generated kube-config should be stored.\nIf this is not defined, vCluster will only create it at `vc-NAME`. If another name is specified here\nvCluster will also create the config in this other secret."
},
"server": {
"description": "Server can be used to override the default https://localhost:8443 and specify a custom hostname for the\ngenerated kube-config.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "ExportKubeConfigSecretReference defines in which secret in the host cluster the generated kube-config should be stored.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kube config should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the kube config secret should get stored. If this is not equal to the namespace\nwhere the vCluster is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcd": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the external etcd should be used.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/ExternalEtcdHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/ExternalEtcdService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/ExternalEtcdStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"ExternalEtcdHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"ExternalEtcdStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"description": "IPBlock describes a particular CIDR (Ex.",
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "Nodes defines if metrics-server nodes api should get proxied from host to vCluster."
},
"pods": {
"$ref": "#/$defs/EnableSwitch",
"description": "Pods defines if metrics-server pods api should get proxied from host to vCluster."
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. prometheus requires a node ip.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to vCluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the vCluster or the other way around."
},
"resolveServices": {
"description": "ResolveServices allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveServices"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the vCluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to vCluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock"
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster should connect to.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra vCluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra vCluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the vCluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds vCluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds vCluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Disabled defines if the cluster role should be disabled. Otherwise, its automatically determined if vCluster requires a cluster role.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the vCluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from vCluster to the host cluster. If services are\nsynced to a different namespace than the vCluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveServiceHostname": {
"additionalProperties": false,
"properties": {
"hostname": {
"type": "string"
}
},
"type": "object"
},
"ResolveServiceService": {
"additionalProperties": false,
"properties": {
"service": {
"type": "string"
}
},
"type": "object"
},
"ResolveServiceTarget": {
"additionalProperties": false,
"properties": {
"external": {
"$ref": "#/$defs/ResolveServiceHostname"
},
"host": {
"$ref": "#/$defs/ResolveServiceService"
},
"vcluster": {
"$ref": "#/$defs/ResolveServiceService"
}
},
"type": "object"
},
"ResolveServices": {
"additionalProperties": false,
"properties": {
"service": {
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveServiceTarget"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"$ref": "#/$defs/ScopeSelector",
"description": "ScopeSelector is the resource quota scope selector"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"ScopeSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "FromHost configures what resources should get purely synced from the host cluster to the vCluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "ToHost configures what resources should get synced from the vCluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the vCluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the vCluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the vCluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the vCluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the vCluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the vCluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the vCluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to vCluster. This will also set the node selector when syncing a pod from vCluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the vCluster."
},
"syncAll": {
"description": "SyncAll specifies if all nodes should get synced by vCluster from the host to the vCluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"syncLabelsTaints": {
"description": "SyncLabelsTaints enables syncing labels and taints from the vCluster to the host cluster. If this is enabled someone within the vCluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the vCluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. vCluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe vCluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the vCluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by vCluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image vCluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the vCluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the vCluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the vCluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the vCluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the vCluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the vCluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the vCluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the vCluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the vCluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the vCluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the vCluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the vCluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the vCluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the vCluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"disabled": {
"description": "Disabled specifies that the telemetry for vCluster control plane should be disabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kube config path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "Disabled signals to disable deploying a persistent volume claim. If false, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "ControlPlane holds options how to configure the vCluster control-plane"
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental are alpha features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kube config"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking are networking options related to the vCluster"
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the vCluster"
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options how vCluster should connect to vCluster platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies what vCluster plugins to enable. Please use \"plugins\" instead. Please do not use that option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugins define what vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies defines policies to enforce for the vCluster deployment as well as within the vCluster"
},
"pro": {
"description": "Pro specifies if vCluster pro should be used. This is automatically inferred in newer versions. Please do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC are role based access control options for the vCluster"
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the vCluster. Please do not use that option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the vCluster to host cluster and back"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry is the configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 060d95880f1a362a8f918065b99b18cd9ba0c677 | 2024-04-15T16:03:14 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths.",
"pro": true
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster",
"pro": true
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"pro": true,
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"pro": true,
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Configure the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'ghcr.io/loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 75e98ff3265133f0deb0a458161f69fb34f4518d | 2024-04-15T09:05:59 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Configure the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'ghcr.io/loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | d5354f8a8dfe85a0895943bbcf9af6e1865d7592 | 2024-03-26T09:49:43 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"embeddedEtcd": {
"$ref": "#/$defs/EmbeddedEtcd",
"description": "EmbeddedEtcd defines to use embedded etcd as a storage backend for the virtual cluster"
},
"externalEtcd": {
"$ref": "#/$defs/ExternalEtcd",
"description": "ExternalEtcd defines to use an external etcd deployed by the Helm chart as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": true,
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will fallback to the default distro backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything coredns related."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": true,
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods are additional labels or annotations for the statefulSet pod."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.\n+optional",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.\n+optional",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the scheduler."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.virtualScheduler.enabled"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EmbeddedEtcd": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromExternalEtcd": {
"description": "MigrateFromExternalEtcd signals that vCluster should migrate from the external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcd": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the external etcd should be used.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/ExternalEtcdHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/ExternalEtcdService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/ExternalEtcdStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"ExternalEtcdHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"ExternalEtcdStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"description": "IPBlock describes a particular CIDR (Ex.",
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock"
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"type": "string"
},
"namespace": {
"type": "string"
},
"service": {
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"type": "string"
},
"ip": {
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"$ref": "#/$defs/ScopeSelector",
"description": "ScopeSelector is the resource quota scope selector"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional",
"type": "string"
}
},
"type": "object"
},
"ScopeSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | fb33114415bccea167e4b2d4cf93b59fe69d53aa | 2024-04-15T09:49:06 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster",
"pro": true
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"pro": true,
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"pro": true,
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Configure the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'ghcr.io/loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 6016bee0027084ad227ae4abee23531e27be8369 | 2024-04-08T08:14:26 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 3ffc859ddae1a58160473657f807713f8548f653 | 2024-04-05T16:40:12 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster"
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will fallback to the default distro backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything coredns related."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": true,
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods are additional labels or annotations for the statefulSet pod."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format. This is optional for the embedded database.",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.\n+optional",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.\n+optional",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the scheduler."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.virtualScheduler.enabled"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"localManagerMetricsBindAddress": {
"description": "LocalManagerMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualManagerMetricsBindAddress": {
"description": "VirtualManagerMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"$ref": "#/$defs/ScopeSelector",
"description": "ScopeSelector is the resource quota scope selector"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional",
"type": "string"
}
},
"type": "object"
},
"ScopeSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | aec94c188579e2841e19de4494f535b18000f298 | 2024-04-14T10:19:17 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster",
"pro": true
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"pro": true,
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"pro": true,
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Configure the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'ghcr.io/loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 70b3b5b166b4360c80f3e7d06362208674986397 | 2024-04-05T13:50:23 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | ecd69612077bb4ebaba6844f3424a71c91e20a53 | 2024-04-02T07:46:30 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster"
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": true,
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will fallback to the default distro backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything coredns related."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": true,
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods are additional labels or annotations for the statefulSet pod."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format. This is optional for the embedded database.",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.\n+optional",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.\n+optional",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.\n+optional",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the scheduler."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources are the resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.virtualScheduler.enabled"
},
"securityContext": {
"description": "SecurityContext can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller."
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelSelectorRequirement": {
"additionalProperties": false,
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"$ref": "#/$defs/ScopeSelector",
"description": "ScopeSelector is the resource quota scope selector"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.\n\nFor example:\n'pods' means pods.\n'pods/log' means the log subresource of pods.\n'*' means all resources, but not subresources.\n'pods/*' means all subresources of pods.\n'*/scale' means all scale subresources.\n'*/*' means all resources and their subresources.\n\nIf wildcard is present, the validation rule will ensure resources do not\noverlap with each other.\n\nDepending on the enclosing object, subresources might not be allowed.\nRequired.\n+listType=atomic",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "scope specifies the scope of this rule.\nValid values are \"Cluster\", \"Namespaced\", and \"*\"\n\"Cluster\" means that only cluster-scoped resources will match this rule.\nNamespace API objects are cluster-scoped.\n\"Namespaced\" means that only namespaced resources will match this rule.\n\"*\" means that there are no scope restrictions.\nSubresources match the scope of their parent resource.\nDefault is \"*\".\n\n+optional",
"type": "string"
}
},
"type": "object"
},
"ScopeSelector": {
"additionalProperties": false,
"properties": {
"matchExpressions": {
"items": {
"$ref": "#/$defs/LabelSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
loft-sh/vcluster | 80431d372cc95de739f24c9de9053896c3b617f4 | 2024-04-12T23:09:42 | chart/values.schema.json | 5,804 | 2024-05-28T04:58:39.353045Z | {
"$defs": {
"BackingStore": {
"additionalProperties": false,
"properties": {
"database": {
"$ref": "#/$defs/Database",
"description": "Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases."
},
"etcd": {
"$ref": "#/$defs/Etcd",
"description": "Etcd defines that etcd should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"CentralAdmission": {
"additionalProperties": false,
"properties": {
"mutatingWebhooks": {
"description": "MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/MutatingWebhookConfiguration"
},
"type": "array"
},
"validatingWebhooks": {
"description": "ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster",
"items": {
"$ref": "#/$defs/ValidatingWebhookConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlane": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/ControlPlaneAdvanced",
"description": "Advanced holds additional configuration for the vCluster control plane."
},
"backingStore": {
"$ref": "#/$defs/BackingStore",
"description": "BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."
},
"coredns": {
"$ref": "#/$defs/CoreDNS",
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
},
"distro": {
"$ref": "#/$defs/Distro",
"description": "Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."
},
"hostPathMapper": {
"$ref": "#/$defs/HostPathMapper",
"description": "HostPathMapper defines if vCluster should rewrite host paths."
},
"ingress": {
"$ref": "#/$defs/ControlPlaneIngress",
"description": "Ingress defines options for vCluster ingress deployed by Helm."
},
"proxy": {
"$ref": "#/$defs/ControlPlaneProxy",
"description": "Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."
},
"service": {
"$ref": "#/$defs/ControlPlaneService",
"description": "Service defines options for vCluster service deployed by Helm."
},
"serviceMonitor": {
"$ref": "#/$defs/ServiceMonitor",
"description": "ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."
},
"statefulSet": {
"$ref": "#/$defs/ControlPlaneStatefulSet",
"description": "StatefulSet defines options for vCluster statefulSet deployed by Helm."
}
},
"type": "object"
},
"ControlPlaneAdvanced": {
"additionalProperties": false,
"properties": {
"defaultImageRegistry": {
"description": "DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.",
"type": "string"
},
"globalMetadata": {
"$ref": "#/$defs/ControlPlaneGlobalMetadata",
"description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm."
},
"headlessService": {
"$ref": "#/$defs/ControlPlaneHeadlessService",
"description": "HeadlessService specifies options for the headless service used for the vCluster StatefulSet."
},
"serviceAccount": {
"$ref": "#/$defs/ControlPlaneServiceAccount",
"description": "ServiceAccount specifies options for the vCluster control plane service account."
},
"virtualScheduler": {
"$ref": "#/$defs/EnableSwitch",
"description": "VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster."
},
"workloadServiceAccount": {
"$ref": "#/$defs/ControlPlaneWorkloadServiceAccount",
"description": "WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."
}
},
"type": "object"
},
"ControlPlaneGlobalMetadata": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneHighAvailability": {
"additionalProperties": false,
"properties": {
"leaseDuration": {
"description": "LeaseDuration is the time to lease for the leader.",
"type": "integer"
},
"renewDeadline": {
"description": "RenewDeadline is the deadline to renew a lease for the leader.",
"type": "integer"
},
"replicas": {
"description": "Replicas is the amount of replicas to use for the statefulSet.",
"type": "integer"
},
"retryPeriod": {
"description": "RetryPeriod is the time until a replica will retry to get a lease.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneIngress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane ingress should be enabled",
"type": "boolean"
},
"host": {
"description": "Host is the host where vCluster will be reachable",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"pathType": {
"description": "PathType is the path type of the ingress",
"type": "string"
},
"spec": {
"description": "Spec allows you to configure extra ingress options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlanePersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/VolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ControlPlaneProbes": {
"additionalProperties": false,
"properties": {
"livenessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "LivenessProbe specifies if the liveness probe for the container should be enabled"
},
"readinessProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "ReadinessProbe specifies if the readiness probe for the container should be enabled"
},
"startupProbe": {
"$ref": "#/$defs/EnableSwitch",
"description": "StartupProbe specifies if the startup probe for the container should be enabled"
}
},
"type": "object"
},
"ControlPlaneProxy": {
"additionalProperties": false,
"properties": {
"bindAddress": {
"description": "BindAddress under which vCluster will expose the proxy.",
"type": "string"
},
"extraSANs": {
"description": "ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"description": "Port under which vCluster will expose the proxy. Changing port is currently not supported.",
"type": "integer"
}
},
"type": "object"
},
"ControlPlaneScheduling": {
"additionalProperties": false,
"properties": {
"affinity": {
"description": "Affinity is the affinity to apply to the pod.",
"type": "object"
},
"nodeSelector": {
"description": "NodeSelector is the node selector to apply to the pod.",
"type": "object"
},
"podManagementPolicy": {
"description": "PodManagementPolicy is the statefulSet pod management policy.",
"type": "string"
},
"priorityClassName": {
"description": "PriorityClassName is the priority class name for the the pod.",
"type": "string"
},
"tolerations": {
"description": "Tolerations are the tolerations to apply to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints are the topology spread constraints for the pod.",
"items": true,
"type": "array"
}
},
"type": "object"
},
"ControlPlaneSecurity": {
"additionalProperties": false,
"properties": {
"containerSecurityContext": {
"description": "ContainerSecurityContext specifies security context options on the container level.",
"type": "object"
},
"podSecurityContext": {
"description": "PodSecurityContext specifies security context options on the pod level.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the control plane service should be enabled",
"type": "boolean"
},
"httpsNodePort": {
"description": "HTTPSNodePort is the node port where https is exposed. Defaults to 0.",
"type": "integer"
},
"kubeletNodePort": {
"description": "KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec allows you to configure extra service options.",
"type": "object"
}
},
"type": "object"
},
"ControlPlaneServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"args": {
"description": "Args allows you to override the main arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command allows you to override the main command.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Env are additional environment variables for the statefulSet container.",
"items": {
"type": "object"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ControlPlaneHighAvailability",
"description": "HighAvailability holds options related to high availability."
},
"image": {
"$ref": "#/$defs/StatefulSetImage",
"description": "Image is the image for the controlPlane statefulSet container"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the policy how to pull the image.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ControlPlanePersistence",
"description": "Persistence defines options around persistence for the statefulSet."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Additional labels or annotations for the statefulSet pods."
},
"probes": {
"$ref": "#/$defs/ControlPlaneProbes",
"description": "Probes enables or disables the main container probes."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the resource requests and limits for the statefulSet container."
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling holds options related to scheduling."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security defines pod or container security context."
},
"workingDir": {
"description": "WorkingDir specifies in what folder the main process should get started.",
"type": "string"
}
},
"type": "object"
},
"ControlPlaneWorkloadServiceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled specifies if the service account for the workloads should get deployed.",
"type": "boolean"
},
"imagePullSecrets": {
"description": "ImagePullSecrets defines extra image pull secrets for the workload service account.",
"items": {
"$ref": "#/$defs/ImagePullSecretName"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"name": {
"description": "Name specifies what name to use for the service account for the virtual cluster workloads.",
"type": "string"
}
},
"type": "object"
},
"CoreDNS": {
"additionalProperties": false,
"properties": {
"deployment": {
"$ref": "#/$defs/CoreDNSDeployment",
"description": "Deployment holds extra options for the coredns deployment deployed within the virtual cluster"
},
"embedded": {
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if coredns is enabled",
"type": "boolean"
},
"overwriteConfig": {
"description": "OverwriteConfig can be used to overwrite the coredns config",
"type": "string"
},
"overwriteManifests": {
"description": "OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns",
"type": "string"
},
"service": {
"$ref": "#/$defs/CoreDNSService",
"description": "Service holds extra options for the coredns service deployed within the virtual cluster"
}
},
"type": "object"
},
"CoreDNSDeployment": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"image": {
"description": "Image is the coredns image to use",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is the node selector to use for coredns.",
"type": "object"
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods is additional metadata for the coredns pods."
},
"replicas": {
"description": "Replicas is the amount of coredns pods to run.",
"type": "integer"
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources are the desired resources for coredns."
}
},
"type": "object"
},
"CoreDNSService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"spec": {
"description": "Spec holds extra options for the coredns service",
"type": "object"
}
},
"type": "object"
},
"Database": {
"additionalProperties": false,
"properties": {
"embedded": {
"$ref": "#/$defs/DatabaseKine",
"description": "Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"
},
"external": {
"$ref": "#/$defs/DatabaseKine",
"description": "External defines that an external database should be used as the backend for the virtual cluster"
}
},
"type": "object"
},
"DatabaseKine": {
"additionalProperties": false,
"properties": {
"caFile": {
"description": "CaFile is the ca file to use for the database. This is optional.",
"type": "string"
},
"certFile": {
"description": "CertFile is the cert file to use for the database. This is optional.",
"type": "string"
},
"dataSource": {
"description": "DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s",
"type": "string"
},
"enabled": {
"description": "Enabled defines if the database should be used.",
"type": "boolean"
},
"keyFile": {
"description": "KeyFile is the key file to use for the database. This is optional.",
"type": "string"
}
},
"type": "object"
},
"DenyRule": {
"additionalProperties": false,
"properties": {
"excludedUsers": {
"description": "ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the check.",
"type": "string"
},
"namespaces": {
"description": "Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported.",
"items": {
"$ref": "#/$defs/RuleWithVerbs"
},
"type": "array"
}
},
"type": "object"
},
"Distro": {
"additionalProperties": false,
"properties": {
"eks": {
"$ref": "#/$defs/DistroK8s",
"description": "EKS holds eks relevant configuration."
},
"k0s": {
"$ref": "#/$defs/DistroK0s",
"description": "K0S holds k0s relevant configuration."
},
"k3s": {
"$ref": "#/$defs/DistroK3s",
"description": "K3S holds K3s relevant configuration."
},
"k8s": {
"$ref": "#/$defs/DistroK8s",
"description": "K8S holds K8s relevant configuration."
}
},
"type": "object"
},
"DistroContainer": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroContainerEnabled": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled signals this container should be enabled.",
"type": "boolean"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
}
},
"type": "object"
},
"DistroK0s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config allows you to override the k0s config passed to the k0s binary.",
"type": "string"
},
"enabled": {
"description": "Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"DistroK3s": {
"additionalProperties": false,
"properties": {
"command": {
"description": "Command is the command to start the distro binary. This will override the existing command.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are additional arguments to pass to the distro binary.",
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the distro image"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the distro image",
"type": "string"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
},
"token": {
"description": "Token is the K3s token to use. If empty, vCluster will choose one.",
"type": "string"
}
},
"type": "object"
},
"DistroK8s": {
"additionalProperties": false,
"properties": {
"apiServer": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "APIServer holds configuration specific to starting the api server."
},
"controllerManager": {
"$ref": "#/$defs/DistroContainerEnabled",
"description": "ControllerManager holds configuration specific to starting the controller manager."
},
"enabled": {
"description": "Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables to use for the main container and NOT the init container.",
"items": {
"type": "object"
},
"type": "array"
},
"resources": {
"description": "Resources for the distro init container",
"type": "object"
},
"scheduler": {
"$ref": "#/$defs/DistroContainer",
"description": "Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"
},
"securityContext": {
"description": "Security options can be used for the distro init container",
"type": "object"
}
},
"type": "object"
},
"EnableSwitch": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"Etcd": {
"additionalProperties": false,
"properties": {
"deploy": {
"$ref": "#/$defs/EtcdDeploy",
"description": "Deploy defines to use an external etcd that is deployed by the helm chart"
},
"embedded": {
"$ref": "#/$defs/EtcdEmbedded",
"description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster"
}
},
"type": "object"
},
"EtcdDeploy": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines that an external etcd should be deployed.",
"type": "boolean"
},
"headlessService": {
"$ref": "#/$defs/EtcdDeployHeadlessService",
"description": "HeadlessService holds options for the external etcd headless service."
},
"service": {
"$ref": "#/$defs/EtcdDeployService",
"description": "Service holds options for the external etcd service."
},
"statefulSet": {
"$ref": "#/$defs/EtcdDeployStatefulSet",
"description": "StatefulSet holds options for the external etcd statefulSet."
}
},
"type": "object"
},
"EtcdDeployHeadlessService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd headless service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd headless service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployService": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for the external etcd service",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the etcd service should be deployed",
"type": "boolean"
}
},
"type": "object"
},
"EtcdDeployStatefulSet": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the statefulSet should be deployed",
"type": "boolean"
},
"env": {
"description": "Env are extra environment variables",
"items": {
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "ExtraArgs are appended to the etcd command.",
"items": {
"type": "string"
},
"type": "array"
},
"highAvailability": {
"$ref": "#/$defs/ExternalEtcdHighAvailability",
"description": "HighAvailability are high availability options"
},
"image": {
"$ref": "#/$defs/Image",
"description": "Image is the image to use for the external etcd statefulSet"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy for the external etcd image",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"persistence": {
"$ref": "#/$defs/ExternalEtcdPersistence",
"description": "Persistence options for the etcd pods."
},
"pods": {
"$ref": "#/$defs/LabelsAndAnnotations",
"description": "Pods defines extra metadata for the etcd pods."
},
"resources": {
"$ref": "#/$defs/Resources",
"description": "Resources the etcd can consume"
},
"scheduling": {
"$ref": "#/$defs/ControlPlaneScheduling",
"description": "Scheduling options for the etcd pods."
},
"security": {
"$ref": "#/$defs/ControlPlaneSecurity",
"description": "Security options for the etcd pods."
}
},
"type": "object"
},
"EtcdEmbedded": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the embedded etcd should be used.",
"pro": true,
"type": "boolean"
},
"migrateFromDeployedEtcd": {
"description": "MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.",
"type": "boolean"
}
},
"type": "object"
},
"Experimental": {
"additionalProperties": false,
"properties": {
"denyProxyRequests": {
"description": "DenyProxyRequests denies certain requests in the vCluster proxy.",
"items": {
"$ref": "#/$defs/DenyRule"
},
"pro": true,
"type": "array"
},
"deploy": {
"$ref": "#/$defs/ExperimentalDeploy",
"description": "Deploy allows you to configure manifests and Helm charts to deploy within the virtual cluster."
},
"genericSync": {
"$ref": "#/$defs/ExperimentalGenericSync",
"description": "GenericSync holds options to generically sync resources from virtual cluster to host."
},
"isolatedControlPlane": {
"$ref": "#/$defs/ExperimentalIsolatedControlPlane",
"description": "IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.",
"pro": true
},
"multiNamespaceMode": {
"$ref": "#/$defs/ExperimentalMultiNamespaceMode",
"description": "MultiNamespaceMode tells virtual cluster to sync to multiple namespaces instead of a single one. This will map each virtual cluster namespace to a single namespace in the host cluster."
},
"syncSettings": {
"$ref": "#/$defs/ExperimentalSyncSettings",
"description": "SyncSettings are advanced settings for the syncer controller.",
"pro": true
},
"virtualClusterKubeConfig": {
"$ref": "#/$defs/VirtualClusterKubeConfig",
"description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."
}
},
"type": "object"
},
"ExperimentalDeploy": {
"additionalProperties": false,
"properties": {
"helm": {
"description": "Helm are Helm charts that should get deployed into the virtual cluster",
"items": {
"$ref": "#/$defs/ExperimentalDeployHelm"
},
"type": "array"
},
"manifests": {
"description": "Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.",
"type": "string"
},
"manifestsTemplate": {
"description": "ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelm": {
"additionalProperties": false,
"properties": {
"bundle": {
"description": "Bundle allows to compress the Helm chart and specify this instead of an online chart",
"type": "string"
},
"chart": {
"$ref": "#/$defs/ExperimentalDeployHelmChart",
"description": "Chart defines what chart should get deployed."
},
"release": {
"$ref": "#/$defs/ExperimentalDeployHelmRelease",
"description": "Release defines what release should get deployed."
},
"timeout": {
"description": "Timeout defines the timeout for Helm",
"type": "string"
},
"values": {
"description": "Values defines what values should get used.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmChart": {
"additionalProperties": false,
"properties": {
"insecure": {
"type": "boolean"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"repo": {
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ExperimentalDeployHelmRelease": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the release",
"type": "string"
},
"namespace": {
"description": "Namespace of the release",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSync": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"export": {
"description": "Exports syncs a resource from the virtual cluster to the host",
"items": {
"$ref": "#/$defs/Export"
},
"type": "array"
},
"hooks": {
"$ref": "#/$defs/Hooks",
"description": "Hooks are hooks that can be used to inject custom patches before syncing"
},
"import": {
"description": "Imports syncs a resource from the host cluster to virtual cluster",
"items": {
"$ref": "#/$defs/Import"
},
"type": "array"
},
"role": {
"$ref": "#/$defs/ExperimentalGenericSyncExtraRules"
},
"version": {
"description": "Version is the config version",
"type": "string"
}
},
"type": "object"
},
"ExperimentalGenericSyncExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"items": true,
"type": "array"
}
},
"type": "object"
},
"ExperimentalIsolatedControlPlane": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if the isolated control plane feature should be enabled.",
"type": "boolean"
},
"headless": {
"description": "Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.",
"type": "boolean"
},
"kubeConfig": {
"description": "KubeConfig is the path where to find the remote workload cluster kubeconfig.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace where to sync the workloads into.",
"type": "string"
},
"service": {
"description": "Service is the vCluster service in the remote cluster.",
"type": "string"
}
},
"type": "object"
},
"ExperimentalMultiNamespaceMode": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if multi namespace mode should get enabled",
"type": "boolean"
},
"namespaceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "NamespaceLabels are extra labels that will be added by vCluster to each created namespace.",
"type": "object"
}
},
"type": "object"
},
"ExperimentalSyncSettings": {
"additionalProperties": false,
"properties": {
"disableSync": {
"description": "DisableSync will not sync any resources and disable most control plane functionality.",
"type": "boolean"
},
"hostMetricsBindAddress": {
"description": "HostMetricsBindAddress is the bind address for the local manager",
"type": "string"
},
"rewriteKubernetesService": {
"description": "RewriteKubernetesService will rewrite the Kubernetes service to point to the vCluster service if disableSync is enabled",
"type": "boolean"
},
"setOwner": {
"description": "SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.",
"type": "boolean"
},
"syncLabels": {
"description": "SyncLabels are labels that should get not rewritten when syncing from the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"targetNamespace": {
"description": "TargetNamespace is the namespace where the workloads should get synced to.",
"type": "string"
},
"virtualMetricsBindAddress": {
"description": "VirtualMetricsBindAddress is the bind address for the virtual manager",
"type": "string"
}
},
"type": "object"
},
"Export": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"selector": {
"$ref": "#/$defs/Selector",
"description": "Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."
}
},
"type": "object"
},
"ExportKubeConfig": {
"additionalProperties": false,
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.",
"properties": {
"context": {
"description": "Context is the name of the context within the generated kubeconfig to use.",
"type": "string"
},
"secret": {
"$ref": "#/$defs/ExportKubeConfigSecretReference",
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret."
},
"server": {
"description": "Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.",
"type": "string"
}
},
"type": "object"
},
"ExportKubeConfigSecretReference": {
"additionalProperties": false,
"description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.",
"properties": {
"name": {
"description": "Name is the name of the secret where the kubeconfig should get stored.",
"type": "string"
},
"namespace": {
"description": "Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"ExternalEtcdHighAvailability": {
"additionalProperties": false,
"properties": {
"replicas": {
"description": "Replicas are the amount of pods to use.",
"type": "integer"
}
},
"type": "object"
},
"ExternalEtcdPersistence": {
"additionalProperties": false,
"properties": {
"addVolumeMounts": {
"description": "AddVolumeMounts defines extra volume mounts for the container",
"items": {
"$ref": "#/$defs/VolumeMount"
},
"type": "array"
},
"addVolumes": {
"description": "AddVolumes defines extra volumes for the pod",
"items": {
"type": "object"
},
"type": "array"
},
"volumeClaim": {
"$ref": "#/$defs/ExternalEtcdPersistenceVolumeClaim",
"description": "VolumeClaim can be used to configure the persistent volume claim."
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExternalEtcdPersistenceVolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim.",
"type": "boolean"
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"Hook": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"patches": {
"description": "Patches are the patches to apply on the object to be synced",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"verbs": {
"description": "Verbs are the verbs that the hook should mutate",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Hooks": {
"additionalProperties": false,
"properties": {
"hostToVirtual": {
"description": "HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
},
"virtualToHost": {
"description": "VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster",
"items": {
"$ref": "#/$defs/Hook"
},
"type": "array"
}
},
"type": "object"
},
"HostPathMapper": {
"additionalProperties": false,
"properties": {
"central": {
"description": "Central specifies if the central host path mapper will be used",
"pro": true,
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if the host path mapper will be used",
"type": "boolean"
}
},
"type": "object"
},
"IPBlock": {
"additionalProperties": false,
"properties": {
"cidr": {
"description": "cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string"
},
"except": {
"description": "except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Image": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Repository is the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"ImagePullSecretName": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the image pull secret to use.",
"type": "string"
}
},
"type": "object"
},
"Import": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion of the object to sync",
"type": "string"
},
"kind": {
"description": "Kind of the object to sync",
"type": "string"
},
"optional": {
"type": "boolean"
},
"patches": {
"description": "Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
},
"replaceOnConflict": {
"description": "ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying",
"type": "boolean"
},
"reversePatches": {
"description": "ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster",
"items": {
"$ref": "#/$defs/Patch"
},
"type": "array"
}
},
"type": "object"
},
"LabelsAndAnnotations": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"LimitRange": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"default": {
"description": "Default are the default limits for the limit range",
"type": "object"
},
"defaultRequest": {
"description": "DefaultRequest are the default request options for the limit range",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the limit range should be deployed by vCluster.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
}
},
"type": "object"
},
"MetricsProxy": {
"additionalProperties": false,
"properties": {
"nodes": {
"description": "Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.",
"type": "boolean"
},
"pods": {
"description": "Pods defines if metrics-server pods api should get proxied from host to virtual cluster.",
"type": "boolean"
}
},
"type": "object"
},
"MutatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"reinvocationPolicy": {
"description": "reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\".",
"type": "string"
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"MutatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/MutatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"NetworkPolicy": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the network policy should be deployed by vCluster.",
"type": "boolean"
},
"fallbackDns": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"outgoingConnections": {
"$ref": "#/$defs/OutgoingConnections"
}
},
"type": "object"
},
"NetworkProxyKubelets": {
"additionalProperties": false,
"properties": {
"byHostname": {
"description": "ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP.",
"type": "boolean"
},
"byIP": {
"description": "ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic.",
"type": "boolean"
}
},
"type": "object"
},
"Networking": {
"additionalProperties": false,
"properties": {
"advanced": {
"$ref": "#/$defs/NetworkingAdvanced",
"description": "Advanced holds advanced network options."
},
"replicateServices": {
"$ref": "#/$defs/ReplicateServices",
"description": "ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."
},
"resolveDNS": {
"description": "ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.",
"items": {
"$ref": "#/$defs/ResolveDNS"
},
"pro": true,
"type": "array"
}
},
"type": "object"
},
"NetworkingAdvanced": {
"additionalProperties": false,
"properties": {
"clusterDomain": {
"description": "ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.",
"type": "string"
},
"fallbackHostCluster": {
"description": "FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace",
"type": "boolean"
},
"proxyKubelets": {
"$ref": "#/$defs/NetworkProxyKubelets",
"description": "ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."
}
},
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.",
"type": "object"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.",
"type": "string"
}
},
"type": "object"
},
"Observability": {
"additionalProperties": false,
"properties": {
"metrics": {
"$ref": "#/$defs/ObservabilityMetrics",
"description": "Metrics allows to proxy metrics server apis from host to virtual cluster."
}
},
"type": "object"
},
"ObservabilityMetrics": {
"additionalProperties": false,
"properties": {
"proxy": {
"$ref": "#/$defs/MetricsProxy",
"description": "Proxy holds the configuration what metrics-server apis should get proxied."
}
},
"type": "object"
},
"OutgoingConnections": {
"additionalProperties": false,
"properties": {
"ipBlock": {
"$ref": "#/$defs/IPBlock",
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."
}
},
"type": "object"
},
"Patch": {
"additionalProperties": false,
"properties": {
"conditions": {
"description": "Conditions are conditions that must be true for\nthe patch to get executed",
"items": {
"$ref": "#/$defs/PatchCondition"
},
"type": "array"
},
"fromPath": {
"description": "FromPath is the path from the other object",
"type": "string"
},
"ignore": {
"description": "Ignore determines if the path should be ignored if handled as a reverse patch",
"type": "boolean"
},
"namePath": {
"description": "NamePath is the path to the name of a child resource within Path",
"type": "string"
},
"namespacePath": {
"description": "NamespacePath is path to the namespace of a child resource within Path",
"type": "string"
},
"op": {
"description": "Operation is the type of the patch",
"type": "string"
},
"path": {
"description": "Path is the path of the patch",
"type": "string"
},
"regex": {
"description": "Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace",
"type": "string"
},
"sync": {
"$ref": "#/$defs/PatchSync",
"description": "Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"
},
"value": {
"description": "Value is the new value to be set to the path"
}
},
"type": "object"
},
"PatchCondition": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "Empty means that the path value should be empty or unset",
"type": "boolean"
},
"equal": {
"description": "Equal is the value the path should be equal to"
},
"notEqual": {
"description": "NotEqual is the value the path should not be equal to"
},
"path": {
"description": "Path is the path within the object to select",
"type": "string"
},
"subPath": {
"description": "SubPath is the path below the selected object to select",
"type": "string"
}
},
"type": "object"
},
"PatchSync": {
"additionalProperties": false,
"properties": {
"configmap": {
"type": "boolean"
},
"secret": {
"type": "boolean"
}
},
"type": "object"
},
"Platform": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/PlatformAPIKey",
"description": "APIKey defines how vCluster can find the api key used for the platform."
},
"name": {
"description": "Name is the name of the vCluster instance in the vCluster platform",
"type": "string"
},
"owner": {
"$ref": "#/$defs/PlatformOwner",
"description": "Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user."
},
"project": {
"description": "Project is the project within the platform where the vCluster instance should connect.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKey": {
"additionalProperties": false,
"properties": {
"secretRef": {
"$ref": "#/$defs/PlatformAPIKeySecretReference",
"description": "SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:\n* platform.apiKey.value\n* environment variable called LICENSE\n* secret specified under platform.secret.name\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"
},
"value": {
"description": "Value specifies the api key as a regular text value.",
"type": "string"
}
},
"type": "object"
},
"PlatformAPIKeySecretReference": {
"additionalProperties": false,
"description": "PlatformAPIKeySecretReference defines where to find the platform api key.",
"properties": {
"name": {
"description": "Name is the name of the secret where the platform api key is stored. This defaults to vcluster-platform-api-key if undefined.",
"type": "string"
},
"namespace": {
"description": "Namespace defines the namespace where the api key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.",
"type": "string"
}
},
"type": "object"
},
"PlatformOwner": {
"additionalProperties": false,
"properties": {
"team": {
"description": "Team is the team id within the platform. This is mutually exclusive with user.",
"type": "string"
},
"user": {
"description": "User is the user id within the platform. This is mutually exclusive with team.",
"type": "string"
}
},
"type": "object"
},
"Plugin": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"env": {
"items": true,
"type": "array"
},
"envFrom": {
"items": true,
"type": "array"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"lifecycle": {
"type": "object"
},
"livenessProbe": {
"type": "object"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"optional": {
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"readinessProbe": {
"type": "object"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"startupProbe": {
"type": "object"
},
"version": {
"description": "Version is the plugin version, this is only needed for legacy plugins.",
"type": "string"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
},
"workingDir": {
"type": "string"
}
},
"type": "object"
},
"Plugins": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Args are the arguments that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Command is the command that should be used for the init container",
"items": {
"type": "string"
},
"type": "array"
},
"config": {
"description": "Config is the plugin config to use. This can be arbitrary config used for the plugin.",
"type": "object"
},
"image": {
"description": "Image is the container image that should be used for the plugin",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the pull policy to use for the container image",
"type": "string"
},
"name": {
"description": "Name is the name of the init-container and NOT the plugin name",
"type": "string"
},
"rbac": {
"$ref": "#/$defs/PluginsRBAC",
"description": "RBAC holds additional rbac configuration for the plugin"
},
"resources": {
"description": "Resources are the container resources used for the init container",
"type": "object"
},
"securityContext": {
"description": "SecurityContext is the container security context used for the init container",
"type": "object"
},
"volumeMounts": {
"description": "VolumeMounts are extra volume mounts for the init container",
"items": true,
"type": "array"
}
},
"type": "object"
},
"PluginsExtraRules": {
"additionalProperties": false,
"properties": {
"extraRules": {
"description": "ExtraRules are extra rbac permissions roles that will be added to role or cluster role",
"items": {
"$ref": "#/$defs/RBACPolicyRule"
},
"type": "array"
}
},
"type": "object"
},
"PluginsRBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"
},
"role": {
"$ref": "#/$defs/PluginsExtraRules",
"description": "Role holds extra virtual cluster role permissions for the plugin"
}
},
"type": "object"
},
"Policies": {
"additionalProperties": false,
"properties": {
"centralAdmission": {
"$ref": "#/$defs/CentralAdmission",
"description": "CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.",
"pro": true
},
"limitRange": {
"$ref": "#/$defs/LimitRange",
"description": "LimitRange specifies limit range options."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "NetworkPolicy specifies network policy options."
},
"podSecurityStandard": {
"description": "PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged",
"type": "string"
},
"resourceQuota": {
"$ref": "#/$defs/ResourceQuota",
"description": "ResourceQuota specifies resource quota options."
}
},
"type": "object"
},
"RBAC": {
"additionalProperties": false,
"properties": {
"clusterRole": {
"$ref": "#/$defs/RBACClusterRole",
"description": "ClusterRole holds virtual cluster cluster role configuration"
},
"role": {
"$ref": "#/$defs/RBACRole",
"description": "Role holds virtual cluster role configuration"
}
},
"type": "object"
},
"RBACClusterRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"extraRules": {
"description": "ExtraRules will add rules to the cluster role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the cluster role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RBACPolicyRule": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.",
"items": {
"type": "string"
},
"type": "array"
},
"nonResourceURLs": {
"description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to. '*' represents all resources.",
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RBACRole": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if the role should be enabled or disabled.",
"type": "boolean"
},
"extraRules": {
"description": "ExtraRules will add rules to the role.",
"items": {
"type": "object"
},
"type": "array"
},
"overwriteRules": {
"description": "OverwriteRules will overwrite the role rules completely.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ReplicateServices": {
"additionalProperties": false,
"properties": {
"fromHost": {
"description": "FromHost defines the services that should get synced from the host to the virtual cluster.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
},
"toHost": {
"description": "ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required.",
"items": {
"$ref": "#/$defs/ServiceMapping"
},
"type": "array"
}
},
"type": "object"
},
"ResolveDNS": {
"additionalProperties": false,
"properties": {
"hostname": {
"description": "Hostname is the hostname within the vCluster that should be resolved from.",
"type": "string"
},
"namespace": {
"description": "Namespace is the virtual cluster namespace that should be resolved from.",
"type": "string"
},
"service": {
"description": "Service is the virtual cluster service that should be resolved from.",
"type": "string"
},
"target": {
"$ref": "#/$defs/ResolveDNSTarget",
"description": "Target is the DNS target that should get mapped to"
}
},
"type": "object"
},
"ResolveDNSTarget": {
"additionalProperties": false,
"properties": {
"hostNamespace": {
"description": "HostNamespace to target",
"type": "string"
},
"hostService": {
"description": "HostService to target, format is hostNamespace/hostService",
"type": "string"
},
"hostname": {
"description": "Hostname to use as a DNS target",
"type": "string"
},
"ip": {
"description": "IP to use as a DNS target",
"type": "string"
},
"vClusterService": {
"description": "VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService",
"type": "string"
}
},
"type": "object"
},
"ResourceQuota": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are extra annotations for this resource.",
"type": "object"
},
"enabled": {
"description": "Enabled defines if the resource quota should be enabled.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are extra labels for this resource.",
"type": "object"
},
"quota": {
"description": "Quota are the quota options",
"type": "object"
},
"scopeSelector": {
"description": "ScopeSelector is the resource quota scope selector",
"type": "object"
},
"scopes": {
"description": "Scopes are the resource quota scopes",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Resources": {
"additionalProperties": false,
"properties": {
"limits": {
"description": "Limits are resource limits for the container",
"type": "object"
},
"requests": {
"description": "Requests are minimal resources that will be consumed by the container",
"type": "object"
}
},
"type": "object"
},
"RuleWithVerbs": {
"additionalProperties": false,
"properties": {
"apiGroups": {
"description": "APIGroups is the API groups the resources belong to. '*' is all groups.",
"items": {
"type": "string"
},
"type": "array"
},
"apiVersions": {
"description": "APIVersions is the API versions the resources belong to. '*' is all versions.",
"items": {
"type": "string"
},
"type": "array"
},
"operations": {
"description": "Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one.",
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"description": "Resources is a list of resources this rule applies to.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "Scope specifies the scope of this rule.",
"type": "string"
}
},
"type": "object"
},
"Selector": {
"additionalProperties": false,
"properties": {
"labelSelector": {
"additionalProperties": {
"type": "string"
},
"description": "LabelSelector are the labels to select the object from",
"type": "object"
}
},
"type": "object"
},
"ServiceMapping": {
"additionalProperties": false,
"properties": {
"from": {
"description": "From is the service that should get synced. Can be either in the form name or namespace/name.",
"type": "string"
},
"to": {
"description": "To is the target service that it should get synced to. Can be either in the form name or namespace/name.",
"type": "string"
}
},
"type": "object"
},
"ServiceMonitor": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are the extra annotations to add to the service monitor.",
"type": "object"
},
"enabled": {
"description": "Enabled configures if Helm should create the service monitor.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the extra labels to add to the service monitor.",
"type": "object"
}
},
"type": "object"
},
"StatefulSetImage": {
"additionalProperties": false,
"properties": {
"repository": {
"description": "Configure the registry and repository of the container image, e.g. my-registry.com/my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'ghcr.io/loft-sh/vcluster-oss' instead.",
"type": "string"
},
"tag": {
"description": "Tag is the tag of the container image, e.g. latest",
"type": "string"
}
},
"type": "object"
},
"Sync": {
"additionalProperties": false,
"properties": {
"fromHost": {
"$ref": "#/$defs/SyncFromHost",
"description": "Configure what resources vCluster should sync from the host cluster to the virtual cluster."
},
"toHost": {
"$ref": "#/$defs/SyncToHost",
"description": "Configure resources to sync from the virtual cluster to the host cluster."
}
},
"type": "object"
},
"SyncAllResource": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All defines if all resources of that type should get synced or only the necessary ones that are needed.",
"type": "boolean"
},
"enabled": {
"description": "Enabled defines if this option should be enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SyncFromHost": {
"additionalProperties": false,
"properties": {
"csiDrivers": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back."
},
"csiNodes": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"csiStorageCapacities": {
"$ref": "#/$defs/EnableSwitch",
"description": "CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back."
},
"events": {
"$ref": "#/$defs/EnableSwitch",
"description": "Events defines if events should get synced from the host cluster to the virtual cluster, but not back."
},
"ingressClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."
},
"nodes": {
"$ref": "#/$defs/SyncNodes",
"description": "Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back."
}
},
"type": "object"
},
"SyncNodeSelector": {
"additionalProperties": false,
"properties": {
"all": {
"description": "All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.",
"type": "object"
}
},
"type": "object"
},
"SyncNodes": {
"additionalProperties": false,
"properties": {
"clearImageStatus": {
"description": "ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.",
"type": "boolean"
},
"enabled": {
"description": "Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.",
"type": "boolean"
},
"selector": {
"$ref": "#/$defs/SyncNodeSelector",
"description": "Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."
},
"syncBackChanges": {
"description": "SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.",
"type": "boolean"
}
},
"type": "object"
},
"SyncPods": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled defines if pod syncing should be enabled.",
"type": "boolean"
},
"enforceTolerations": {
"description": "EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.",
"items": {
"type": "string"
},
"type": "array"
},
"rewriteHosts": {
"$ref": "#/$defs/SyncRewriteHosts",
"description": "RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."
},
"translateImage": {
"additionalProperties": {
"type": "string"
},
"description": "TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster",
"type": "object"
},
"useSecretsForSATokens": {
"description": "UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation.",
"type": "boolean"
}
},
"type": "object"
},
"SyncRewriteHosts": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies if rewriting stateful set pods should be enabled.",
"type": "boolean"
},
"initContainerImage": {
"description": "InitContainerImage is the image virtual cluster should use to rewrite this FQDN.",
"type": "string"
}
},
"type": "object"
},
"SyncToHost": {
"additionalProperties": false,
"properties": {
"configMaps": {
"$ref": "#/$defs/SyncAllResource",
"description": "ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."
},
"endpoints": {
"$ref": "#/$defs/EnableSwitch",
"description": "Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."
},
"ingresses": {
"$ref": "#/$defs/EnableSwitch",
"description": "Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."
},
"networkPolicies": {
"$ref": "#/$defs/EnableSwitch",
"description": "NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumeClaims": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."
},
"persistentVolumes": {
"$ref": "#/$defs/EnableSwitch",
"description": "PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."
},
"podDisruptionBudgets": {
"$ref": "#/$defs/EnableSwitch",
"description": "PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."
},
"pods": {
"$ref": "#/$defs/SyncPods",
"description": "Pods defines if pods created within the virtual cluster should get synced to the host cluster."
},
"priorityClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."
},
"secrets": {
"$ref": "#/$defs/SyncAllResource",
"description": "Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."
},
"serviceAccounts": {
"$ref": "#/$defs/EnableSwitch",
"description": "ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."
},
"services": {
"$ref": "#/$defs/EnableSwitch",
"description": "Services defines if services created within the virtual cluster should get synced to the host cluster."
},
"storageClasses": {
"$ref": "#/$defs/EnableSwitch",
"description": "StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."
},
"volumeSnapshots": {
"$ref": "#/$defs/EnableSwitch",
"description": "VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enabled specifies that the telemetry for the vCluster control plane should be enabled.",
"type": "boolean"
},
"instanceCreator": {
"type": "string"
},
"machineID": {
"type": "string"
},
"platformInstanceID": {
"type": "string"
},
"platformUserID": {
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhook": {
"additionalProperties": false,
"properties": {
"admissionReviewVersions": {
"description": "AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects.",
"items": {
"type": "string"
},
"type": "array"
},
"clientConfig": {
"$ref": "#/$defs/ValidatingWebhookClientConfig",
"description": "ClientConfig defines how to communicate with the hook."
},
"failurePolicy": {
"description": "FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail.",
"type": "string"
},
"matchConditions": {
"description": "MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed.",
"items": true,
"type": "array"
},
"matchPolicy": {
"description": "matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\".",
"type": "string"
},
"name": {
"description": "The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization.",
"type": "string"
},
"namespaceSelector": {
"description": "NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."
},
"objectSelector": {
"description": "ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."
},
"rules": {
"description": "Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule.",
"items": true,
"type": "array"
},
"sideEffects": {
"description": "SideEffects states whether this webhook has side effects.",
"type": "string"
},
"timeoutSeconds": {
"description": "TimeoutSeconds specifies the timeout for this webhook.",
"type": "integer"
}
},
"type": "object"
},
"ValidatingWebhookClientConfig": {
"additionalProperties": false,
"description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook",
"properties": {
"caBundle": {
"contentEncoding": "base64",
"description": "CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used.",
"type": "string"
},
"service": {
"$ref": "#/$defs/ValidatingWebhookServiceReference",
"description": "Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."
},
"url": {
"description": "URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified.",
"type": "string"
}
},
"type": "object"
},
"ValidatingWebhookConfiguration": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.",
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta",
"description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."
},
"webhooks": {
"description": "Webhooks is a list of webhooks and the affected resources and operations.",
"items": {
"$ref": "#/$defs/ValidatingWebhook"
},
"type": "array"
}
},
"type": "object"
},
"ValidatingWebhookServiceReference": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Name is the name of the service.",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of the service.",
"type": "string"
},
"path": {
"description": "Path is an optional URL path which will be sent in any request to\nthis service.",
"type": "string"
},
"port": {
"description": "If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive).",
"type": "integer"
}
},
"type": "object"
},
"VirtualClusterKubeConfig": {
"additionalProperties": false,
"properties": {
"clientCACert": {
"description": "ServerCAKey is the client ca cert path.",
"type": "string"
},
"kubeConfig": {
"description": "KubeConfig is the virtual cluster kubeconfig path.",
"type": "string"
},
"requestHeaderCACert": {
"description": "RequestHeaderCACert is the request header ca cert path.",
"type": "string"
},
"serverCACert": {
"description": "ServerCAKey is the server ca cert path.",
"type": "string"
},
"serverCAKey": {
"description": "ServerCAKey is the server ca key path.",
"type": "string"
}
},
"type": "object"
},
"VolumeClaim": {
"additionalProperties": false,
"properties": {
"accessModes": {
"description": "AccessModes are the persistent volume claim access modes.",
"items": {
"type": "string"
},
"type": "array"
},
"enabled": {
"description": "Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required.",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"retentionPolicy": {
"description": "RetentionPolicy is the persistent volume claim retention policy.",
"type": "string"
},
"size": {
"description": "Size is the persistent volume claim storage size.",
"type": "string"
},
"storageClass": {
"description": "StorageClass is the persistent volume claim storage class.",
"type": "string"
}
},
"type": "object"
},
"VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://vcluster.com/schemas/config",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config is the vCluster config.",
"properties": {
"controlPlane": {
"$ref": "#/$defs/ControlPlane",
"description": "Configure vCluster's control plane components and deployment."
},
"experimental": {
"$ref": "#/$defs/Experimental",
"description": "Experimental features for vCluster. Configuration here might change, so be careful with this."
},
"exportKubeConfig": {
"$ref": "#/$defs/ExportKubeConfig",
"description": "ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."
},
"global": {
"description": "Global values shared across all (sub)charts"
},
"networking": {
"$ref": "#/$defs/Networking",
"description": "Networking options related to the virtual cluster."
},
"observability": {
"$ref": "#/$defs/Observability",
"description": "Observability holds options to proxy metrics from the host cluster into the virtual cluster."
},
"platform": {
"$ref": "#/$defs/Platform",
"description": "Platform holds options for connecting to vCluster Platform."
},
"plugin": {
"additionalProperties": {
"$ref": "#/$defs/Plugin"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."
},
"plugins": {
"additionalProperties": {
"$ref": "#/$defs/Plugins"
},
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"type": "object"
},
{
"type": "object"
}
],
"description": "Define which vCluster plugins to load."
},
"policies": {
"$ref": "#/$defs/Policies",
"description": "Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."
},
"pro": {
"description": "Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.",
"type": "boolean"
},
"rbac": {
"$ref": "#/$defs/RBAC",
"description": "RBAC options for the virtual cluster."
},
"serviceCIDR": {
"description": "ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.",
"type": "string"
},
"sync": {
"$ref": "#/$defs/Sync",
"description": "Sync describes how to sync resources from the virtual cluster to host cluster and back."
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Configuration related to telemetry gathered about vCluster usage."
}
},
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 720ae3ecb4215492e4cc5bf273bb462a3d8700de | 2023-07-13T18:41:11 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 2d5fe4b4669e22280404512a01bf6d53c00d8193 | 2023-03-13T13:54:42 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 3da63a6193c5c050853608992707d313ee1ca432 | 2024-03-21T10:36:45 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 864b24c24f7f24a26aa2c2b8a89a82478ce03a32 | 2023-02-25T13:27:02 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 7a44e2ff33b03897f91daeac216263da9fce9fca | 2024-05-16T00:01:56 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$id": "compose_spec.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"$id": "#/definitions/config",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"$id": "#/definitions/constraints/service",
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"$id": "#/definitions/deployment",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"$ref": "#/definitions/duration_format"
},
"max_attempts": {
"type": "integer"
},
"window": {
"$ref": "#/definitions/duration_format"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"$ref": "#/definitions/duration_format"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"$ref": "#/definitions/duration_format"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"$ref": "#/definitions/duration_format"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"$ref": "#/definitions/duration_format"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"$id": "#/definitions/development",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"watch": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"$id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"duration_format": {
"pattern": "^([0-9]+h)?([0-9]+m)?([0-9]+s)?([0-9]+ms)?([0-9]+us)?([0-9]+ns)?$",
"type": "string"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"expose_format": {
"pattern": "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))(-((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4})))?(/tcp|udp)?$",
"type": "string"
},
"generic_resources": {
"$id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"$id": "#/definitions/healthcheck",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"$ref": "#/definitions/duration_format"
},
"retries": {
"type": "number"
},
"start_interval": {
"$ref": "#/definitions/duration_format"
},
"start_period": {
"$ref": "#/definitions/duration_format"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"$ref": "#/definitions/duration_format"
}
},
"type": "object"
},
"include": {
"$id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"ipv4_subnet_format": {
"pattern": "((^|\\.)((25[0-5])|(2[0-4]\\d)|(1\\d\\d)|([1-9]?\\d))){4}/(?:\\d|[12]\\d|3[01])",
"type": "string"
},
"ipv6_subnet_format": {
"pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))/(?:\\d|[12]\\d|3[01])",
"type": "string"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"$id": "#/definitions/network",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"anyOf": [
{
"$ref": "#/definitions/ipv4_subnet_format"
},
{
"$ref": "#/definitions/ipv6_subnet_format"
}
]
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"port_format": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"port_published_format": {
"pattern": "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))(-((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4})))?$",
"type": "string"
},
"secret": {
"$id": "#/definitions/secret",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"$id": "#/definitions/service",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"oneOf": [
{
"type": "number"
},
{
"pattern": "^\\d{1,5}(-\\d{1,5})?(/(tcp|udp))?$",
"type": "string"
}
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"ipv4_address": {
"format": "ipv4",
"type": "string"
},
"ipv6_address": {
"format": "ipv6",
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"type": "number"
},
{
"pattern": "^((\\d+((\\.\\d+)+|(-\\d+))*):?){1,3}(/(tcp|udp))?$",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"description": "The application protocol (TCP/IP level 4 / OSI level 7) this port is used for. This is optional and can be used as a hint for Compose to offer richer behavior for protocols that it understands",
"type": "string"
},
"host_ip": {
"description": "The Host IP mapping, unspecified means all network interfaces (0.0.0.0)",
"format": "ipv4",
"type": "string"
},
"mode": {
"description": "host: For publishing a host port on each node, or ingress: for a port to be load balanced. Defaults to ingress.",
"pattern": "^ingress|host$",
"type": "string"
},
"name": {
"description": "A human-readable name for the port, used to document it's usage within the service",
"type": "string"
},
"protocol": {
"description": "The port protocol (tcp or udp). Defaults to tcp",
"pattern": "^tcp|udp$",
"type": "string"
},
"published": {
"anyOf": [
{
"$ref": "#/definitions/port_format"
},
{
"$ref": "#/definitions/port_published_format"
}
],
"description": "The publicly exposed port. It is defined as a string and can be set as a range using syntax start-end. It means the actual port is assigned a remaining available port, within the set range."
},
"target": {
"$ref": "#/definitions/port_format",
"description": "The container port"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"$ref": "#/definitions/duration_format"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
},
{
"type": "string"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"$id": "#/definitions/volume",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"$id": "#/properties/configs",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"$id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"$id": "#/properties/secrets",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"$id": "#/properties/services",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"$id": "#/properties/volumes",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 27008f85ac127e4d91e89bcad8bf7686ffde241f | 2023-06-22T08:27:36 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 451d85001893861c6ec78725beb4a5642ae5b8be | 2023-03-21T13:33:34 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 6b214b5b119e65907e1dd4a1145bc0538d5fc77e | 2023-07-06T12:24:07 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 78b22da5f5c8998fde4c7434f19f3f4d01cde648 | 2023-07-06T17:02:51 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | e1b7020286e51d7e04e9b47c1f15457640fb63d3 | 2024-04-04T07:55:33 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | ff4b3416e1d53dd681cbed490ddf504fddc64903 | 2023-10-17T08:45:53 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | ccac4e02dd27883a7dd655cde55a92df9eb58eca | 2024-05-16T12:59:18 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 302cbc20096fcdb4bd9e814076c0099f179c0b4f | 2022-12-23T13:44:12 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | b3080b189946c4b31cbb92b82c71b5c2665a5350 | 2023-09-19T16:01:55 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"ignores": {
"items": {
"type": "string"
},
"type": "array"
},
"quiet_period": {
"type": "string"
},
"trigger": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"paths": {
"items": {
"type": "string"
},
"type": "array"
},
"signal": {
"type": "string"
},
"strategy": {
"type": "string"
}
},
"type": "object"
}
]
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | b0e5a16eaf4438ec9e8a8f25ee8fc0074c3d790c | 2023-11-16T13:58:43 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 77cc0f9575b560c94ca2a3b94db126c54c9e4759 | 2023-12-20T11:06:49 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 81229b935190f0905b7ccc1d48eb39a224a658cf | 2022-12-20T07:55:40 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | b34d2b7cc23d8b0a6d54b35b17b8a85cce72150c | 2023-05-09T09:58:32 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 327dade9e53e386856fcae70a488c27a46397058 | 2023-06-26T12:03:06 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 4ccbdd71694d97c3b011daba6f1d713e745c7807 | 2023-02-16T09:02:54 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 1938efd103f8e0817ca90e5f15177ec0317bbaf8 | 2024-02-13T17:07:04 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | b02a01910790b1a99f1f3266067210e18dfa3ea1 | 2023-11-08T16:12:00 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | c0a8366ae7cdef70aa782d3596248e60ad661c8d | 2022-12-20T10:00:03 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | cf35e8fc53983a245af31cf8f9b255630bb62a00 | 2024-05-15T00:01:59 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | f56dd5c967fb1391caf4e783c36153e733c26d8e | 2023-11-07T09:17:36 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | c9480da2ad9670c2e99126f4aad8f1ffbf6d4a9a | 2024-04-22T13:29:35 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | ec342b4a9c954c2cba8eb72b51f7787aa228501e | 2023-11-20T14:43:44 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | 3ca6106271735553c5100a2a51c67ce7771d4cdb | 2023-03-13T10:33:14 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | aff79210ee2a8ed0fb7ad0afd88f1b184329132f | 2024-04-05T14:26:30 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-spec | a9fd97cb0eb8918b3d1d22ba3ad5697a18367a26 | 2023-09-20T13:04:37 | schema/compose-spec.json | 2,100 | 2024-05-28T04:15:15.335413Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | ce9b87bb4ae1fd5b3b4cdabee1b9089844af6018 | 2024-03-15T08:57:25 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 50501d2d1843973c73b9a1443082a00cf59e727b | 2024-03-14T06:23:38 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 29304bf6ced645b047bf6c893d12318ae0c02f1a | 2022-11-30T19:19:48 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 226dd79cac83245f1aa3d7c3abe17ab6e3220be4 | 2023-03-03T17:09:45 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 16e2509dab54a4a7afba0b6a1b267ac94f529aed | 2023-03-22T00:15:50 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | e49f58620eb3a941aa4f57a54849a333e032b83f | 2023-07-07T00:21:16 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 176b19d68a2d164e28e3b17d669ae78c9647487e | 2023-06-27T00:21:16 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 39db88802575014940d58f7e8e5f55bec3e303a4 | 2022-12-20T09:08:27 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 0f2b5999924826d5d0d546cb8b58e701fd9b854a | 2022-12-23T21:51:20 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 8cf4f0bff89ac1e37dbe5a3bca2373ba4051871e | 2022-07-06T06:16:06 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | f388192b8a39fe22b0ec6858b113549d21490fd5 | 2024-04-07T19:11:36 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | b6527f60270644bea0e0fb97f6b87946b4b524bc | 2023-09-20T14:12:03 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | ed0c8aee546db3e1bb00ac7c62f19161cd61f168 | 2023-11-07T09:29:56 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 35b75e2165f5fc9c5fdff93b00a32d00f5271169 | 2023-05-10T00:16:27 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 5873718b0c886b4eb5519bc58e67ac75be023805 | 2023-11-20T14:55:50 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 3b30ce384ae65516d91d1faa436221c5533e02bd | 2024-05-16T12:56:09 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 873a7819d7e35680cd060577b6589531e789f73f | 2023-02-16T07:16:49 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 2bb8b02735f0bda8d2a4413dfa8b05ded51751e8 | 2023-03-14T00:17:10 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 3d07b9fd4c6d26a6f990c9ca8ca95ecca4ec1795 | 2023-10-12T15:04:43 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 0d9238f31eb4bf621545931076f70494cf22725a | 2023-01-05T11:36:23 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | e9919f6fcb1dbb2fee30ecf052eb303c69019fc6 | 2023-07-13T22:53:39 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 94bd7356c641befdb9b52149fedf297517c9a51c | 2024-05-14T12:55:39 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 2ebf7a5761b859b435caaca0854b9b47696599c6 | 2023-12-20T18:46:44 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 2f59e08401626e35580eaae3d57b0a2465ff5788 | 2023-11-16T14:43:29 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 51b6b3edf0382623c238f6745ffe2627a4bea140 | 2022-05-18T08:49:00 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | ef7847600385fa222eb7c48c913c475c8967cbe6 | 2024-02-20T21:34:21 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 25fe17966316466351cf15d5c09c888e28a760e6 | 2024-05-15T09:26:45 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$id": "compose_spec.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"$id": "#/definitions/config",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"$id": "#/definitions/constraints/service",
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"$id": "#/definitions/deployment",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"$ref": "#/definitions/duration_format"
},
"max_attempts": {
"type": "integer"
},
"window": {
"$ref": "#/definitions/duration_format"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"$ref": "#/definitions/duration_format"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"$ref": "#/definitions/duration_format"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"$ref": "#/definitions/duration_format"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"$ref": "#/definitions/duration_format"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"$id": "#/definitions/development",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"watch": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"$id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"duration_format": {
"pattern": "^([0-9]+h)?([0-9]+m)?([0-9]+s)?([0-9]+ms)?([0-9]+us)?([0-9]+ns)?$",
"type": "string"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"expose_format": {
"pattern": "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))(-((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4})))?(/tcp|udp)?$",
"type": "string"
},
"generic_resources": {
"$id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"$id": "#/definitions/healthcheck",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"$ref": "#/definitions/duration_format"
},
"retries": {
"type": "number"
},
"start_interval": {
"$ref": "#/definitions/duration_format"
},
"start_period": {
"$ref": "#/definitions/duration_format"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"$ref": "#/definitions/duration_format"
}
},
"type": "object"
},
"include": {
"$id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"ipv4_subnet_format": {
"pattern": "((^|\\.)((25[0-5])|(2[0-4]\\d)|(1\\d\\d)|([1-9]?\\d))){4}/(?:\\d|[12]\\d|3[01])",
"type": "string"
},
"ipv6_subnet_format": {
"pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))/(?:\\d|[12]\\d|3[01])",
"type": "string"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"$id": "#/definitions/network",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"anyOf": [
{
"$ref": "#/definitions/ipv4_subnet_format"
},
{
"$ref": "#/definitions/ipv6_subnet_format"
}
]
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"port_format": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"port_published_format": {
"pattern": "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))(-((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4})))?$",
"type": "string"
},
"secret": {
"$id": "#/definitions/secret",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"$id": "#/definitions/service",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"entitlements": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"oneOf": [
{
"type": "number"
},
{
"pattern": "^\\d{1,5}(-\\d{1,5})?(/(tcp|udp))?$",
"type": "string"
}
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"ipv4_address": {
"format": "ipv4",
"type": "string"
},
"ipv6_address": {
"format": "ipv6",
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"type": "number"
},
{
"pattern": "^((\\d+((\\.\\d+)+|(-\\d+))*):?){1,3}(/(tcp|udp))?$",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"app_protocol": {
"description": "The application protocol (TCP/IP level 4 / OSI level 7) this port is used for. This is optional and can be used as a hint for Compose to offer richer behavior for protocols that it understands",
"type": "string"
},
"host_ip": {
"description": "The Host IP mapping, unspecified means all network interfaces (0.0.0.0)",
"format": "ipv4",
"type": "string"
},
"mode": {
"description": "host: For publishing a host port on each node, or ingress: for a port to be load balanced. Defaults to ingress.",
"pattern": "^ingress|host$",
"type": "string"
},
"name": {
"description": "A human-readable name for the port, used to document it's usage within the service",
"type": "string"
},
"protocol": {
"description": "The port protocol (tcp or udp). Defaults to tcp",
"pattern": "^tcp|udp$",
"type": "string"
},
"published": {
"anyOf": [
{
"$ref": "#/definitions/port_format"
},
{
"$ref": "#/definitions/port_published_format"
}
],
"description": "The publicly exposed port. It is defined as a string and can be set as a range using syntax start-end. It means the actual port is assigned a remaining available port, within the set range."
},
"target": {
"$ref": "#/definitions/port_format",
"description": "The container port"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"$ref": "#/definitions/duration_format"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
},
{
"type": "string"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"$id": "#/definitions/volume",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"$id": "#/properties/configs",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"$id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"$id": "#/properties/secrets",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"$id": "#/properties/services",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"$id": "#/properties/volumes",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 190855001678c2e5c59e309fe5bfe6ac99968385 | 2023-11-08T16:20:35 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | 54804a9853d85657292843aec6a3fa0cfc1c941f | 2024-03-15T08:48:06 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"required": [
"path",
"action"
],
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
},
"subpath": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
compose-spec/compose-go | a8185cdf06f829d52384d2f06eb4a0404cfb83ef | 2023-03-13T10:53:42 | schema/compose-spec.json | 324 | 2024-05-28T02:57:01.347599Z | {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | Apache-2.0 | en |
opencomputeproject/ocp-diag-core | 712f5a7daff0229418fdf052b3b6a4e667632c6d | 2022-08-30T23:50:56 | json_spec/output/measurement.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/measurement",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"hardwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md doc"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"subcomponent": {
"$ref": "/opencomputeproject/ocp-diag-core/subcomponent",
"description": "TODO: link to md doc"
},
"unit": {
"description": "TODO: link to md doc",
"type": "string"
},
"validators": {
"description": "TODO: link to md doc",
"items": {
"$ref": "/opencomputeproject/ocp-diag-core/validator"
},
"type": "array"
},
"value": {
"description": "TODO: link to md doc",
"type": [
"string",
"boolean",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "Measurement"
} | MIT | en |
opencomputeproject/ocp-diag-core | 712f5a7daff0229418fdf052b3b6a4e667632c6d | 2022-08-30T23:50:56 | json_spec/output/test_step_start.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/testStepStart",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"name": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name"
],
"title": "Test step start"
} | MIT | en |
opencomputeproject/ocp-diag-core | be9fa8779b277a9930b59381ff1fcea7ff0bb743 | 2022-10-12T14:55:07 | json_spec/output/dut_info.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"hardwareInfo": {
"additionalProperties": false,
"properties": {
"computerSystem": {
"description": "TODO: link to md doc",
"type": "string"
},
"hardwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"location": {
"description": "TODO: link to md doc",
"type": "string"
},
"manager": {
"description": "TODO: link to md doc",
"type": "string"
},
"manufacturer": {
"description": "TODO: link to md doc",
"type": "string"
},
"manufacturerPartNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"odataId": {
"description": "TODO: link to md doc",
"type": "string"
},
"partNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"partType": {
"description": "TODO: link to md doc",
"type": "string"
},
"revision": {
"description": "TODO: link to md doc",
"type": "string"
},
"serialNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"version": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name",
"hardwareInfoId"
]
},
"platformInfo": {
"additionalProperties": false,
"properties": {
"info": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"info"
]
},
"softwareInfo": {
"additionalProperties": false,
"properties": {
"computerSystem": {
"description": "TODO: link to md doc",
"type": "string"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"revision": {
"description": "TODO: link to md doc",
"type": "string"
},
"softwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"softwareType": {
"description": "TODO: link to md doc",
"enum": [
"UNSPECIFIED",
"FIRMWARE",
"SYSTEM",
"APPLICATION"
],
"type": "string"
},
"version": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name",
"softwareInfoId"
]
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/dutInfo",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"dutInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"hardwareInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/hardwareInfo"
},
"type": "array"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md doc"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"platformInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/platformInfo"
},
"type": "array"
},
"softwareInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/softwareInfo"
},
"type": "array"
}
},
"required": [
"id"
],
"title": "Dut info"
} | MIT | en |
opencomputeproject/ocp-diag-core | 4c4da3705a83cbc7f68ae667450be7c25f1fe4d5 | 2022-08-30T23:50:52 | json_spec/output/test_step_artifact.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"extension": {
"properties": {
"content": {
"description": "TODO: link to md",
"type": "object"
},
"name": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"name",
"content"
]
},
"file": {
"$comment": "file is just used in step artifact; extract when more usages appear",
"properties": {
"contentType": {
"description": "TODO: link to md",
"type": "string"
},
"description": {
"description": "TODO: link to md",
"type": "string"
},
"displayName": {
"description": "TODO: link to md",
"type": "string"
},
"isSnapshot": {
"description": "TODO: link to md",
"type": "boolean"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md"
},
"uri": {
"$comment": "maybe this should be more constrained",
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"displayName",
"uri",
"isSnapshot"
]
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/testStepArtifact",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"oneOf": [
{
"properties": {
"testStepStart": {
"$ref": "/opencomputeproject/ocp-diag-core/testStepStart",
"description": "TODO: link to md"
}
},
"required": [
"testStepStart"
]
},
{
"properties": {
"testStepEnd": {
"$ref": "/opencomputeproject/ocp-diag-core/testStepEnd",
"description": "TODO: link to md"
}
},
"required": [
"testStepEnd"
]
},
{
"properties": {
"error": {
"$ref": "/opencomputeproject/ocp-diag-core/error",
"description": "TODO: link to md"
}
},
"required": [
"error"
]
},
{
"properties": {
"log": {
"$ref": "/opencomputeproject/ocp-diag-core/log",
"description": "TODO: link to md"
}
},
"required": [
"log"
]
},
{
"properties": {
"diagnosis": {
"$ref": "/opencomputeproject/ocp-diag-core/diagnosis",
"description": "TODO: link to md"
}
},
"required": [
"diagnosis"
]
},
{
"properties": {
"file": {
"$ref": "#/$defs/file"
}
},
"required": [
"file"
]
},
{
"properties": {
"extension": {
"$ref": "#/$defs/extension"
}
},
"required": [
"extension"
]
}
],
"properties": {
"testStepId": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"testStepId"
],
"title": "Step artifact"
} | MIT | en |
opencomputeproject/ocp-diag-core | d345b0da9a18718fe83398fac6f66da43164c85b | 2023-02-01T20:14:45 | json_spec/output/dut_info.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"hardwareInfo": {
"additionalProperties": false,
"properties": {
"computerSystem": {
"description": "TODO: link to md doc",
"type": "string"
},
"hardwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"location": {
"description": "TODO: link to md doc",
"type": "string"
},
"manager": {
"description": "TODO: link to md doc",
"type": "string"
},
"manufacturer": {
"description": "TODO: link to md doc",
"type": "string"
},
"manufacturerPartNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"odataId": {
"description": "TODO: link to md doc",
"type": "string"
},
"partNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"partType": {
"description": "TODO: link to md doc",
"type": "string"
},
"revision": {
"description": "TODO: link to md doc",
"type": "string"
},
"serialNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"version": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name",
"hardwareInfoId"
]
},
"platformInfo": {
"additionalProperties": false,
"properties": {
"info": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"info"
]
},
"softwareInfo": {
"additionalProperties": false,
"properties": {
"computerSystem": {
"description": "TODO: link to md doc",
"type": "string"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"revision": {
"description": "TODO: link to md doc",
"type": "string"
},
"softwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"softwareType": {
"description": "TODO: link to md doc",
"enum": [
"UNSPECIFIED",
"FIRMWARE",
"SYSTEM",
"APPLICATION"
],
"type": "string"
},
"version": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name",
"softwareInfoId"
]
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/dutInfo",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"dutInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"hardwareInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/hardwareInfo"
},
"type": "array"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md doc"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"platformInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/platformInfo"
},
"type": "array"
},
"softwareInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/softwareInfo"
},
"type": "array"
}
},
"required": [
"dutInfoId"
],
"title": "Dut info"
} | MIT | en |
opencomputeproject/ocp-diag-core | 50465975e20dccfbd622471e4639a139a53706cd | 2023-02-22T03:18:19 | json_spec/output/diagnosis.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"type": {
"description": "TODO: link to md doc",
"enum": [
"PASS",
"FAIL",
"UNKNOWN"
],
"type": "string"
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/diagnosis",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"hardwareInfoId": {
"description": "TODO: link to md",
"type": "string"
},
"message": {
"description": "TODO: link to md",
"type": "string"
},
"sourceLocation": {
"$ref": "/opencomputeproject/ocp-diag-core/sourceLocation",
"description": "TODO: link to md doc"
},
"subcomponent": {
"$ref": "/opencomputeproject/ocp-diag-core/subcomponent",
"description": "TODO: link to md"
},
"type": {
"$ref": "#/$defs/type",
"description": "TODO: link to md"
},
"verdict": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"verdict",
"type"
],
"title": "Diagnosis"
} | MIT | en |
opencomputeproject/ocp-diag-core | cb7fce911db8ff75e540eb031a0e6aae5644cf68 | 2023-02-22T03:19:45 | json_spec/output/diagnosis.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"type": {
"description": "TODO: link to md doc",
"enum": [
"PASS",
"FAIL",
"UNKNOWN"
],
"type": "string"
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/diagnosis",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"hardwareInfoId": {
"description": "TODO: link to md",
"type": "string"
},
"message": {
"description": "TODO: link to md",
"type": "string"
},
"sourceLocation": {
"$ref": "/opencomputeproject/ocp-diag-core/sourceLocation",
"description": "SourceLocation information for debugging or tracing program execution. See sourceLocation field in https://github.com/opencomputeproject/ocp-diag-core/blob/main/json_spec/README.md#diagnosis"
},
"subcomponent": {
"$ref": "/opencomputeproject/ocp-diag-core/subcomponent",
"description": "TODO: link to md"
},
"type": {
"$ref": "#/$defs/type",
"description": "TODO: link to md"
},
"verdict": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"verdict",
"type"
],
"title": "Diagnosis"
} | MIT | en |
opencomputeproject/ocp-diag-core | 712f5a7daff0229418fdf052b3b6a4e667632c6d | 2022-08-30T23:50:56 | json_spec/output/measurement_series_end.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/measurementSeriesEnd",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"measurementSeriesId": {
"description": "TODO: link to md doc",
"type": "string"
},
"totalCount": {
"description": "TODO: link to md doc",
"minimum": 0,
"type": "integer"
}
},
"required": [
"measurementSeriesId",
"totalCount"
],
"title": "measurementSeriesEnd"
} | MIT | en |
opencomputeproject/ocp-diag-core | 712f5a7daff0229418fdf052b3b6a4e667632c6d | 2022-08-30T23:50:56 | json_spec/output/test_run_artifact.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/testRunArtifact",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"oneOf": [
{
"properties": {
"testRunStart": {
"$ref": "/opencomputeproject/ocp-diag-core/testRunStart",
"description": "TODO: link to md"
}
},
"required": [
"testRunStart"
]
},
{
"properties": {
"testRunEnd": {
"$ref": "/opencomputeproject/ocp-diag-core/testRunEnd",
"description": "TODO: link to md"
}
},
"required": [
"testRunEnd"
]
},
{
"properties": {
"log": {
"$ref": "/opencomputeproject/ocp-diag-core/log",
"description": "TODO: link to md"
}
},
"required": [
"log"
]
},
{
"properties": {
"error": {
"$ref": "/opencomputeproject/ocp-diag-core/error",
"description": "TODO: link to md"
}
},
"required": [
"error"
]
}
],
"title": "Test run artifact",
"unevaluatedProperties": false
} | MIT | en |
opencomputeproject/ocp-diag-core | 090aad3149fc8965e04ec67299e55ef95d37d655 | 2022-08-30T23:50:53 | json_spec/output/measurement_series_start.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/measurementSeriesStart",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"properties": {
"hardwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"measurementSeriesId": {
"description": "TODO: link to md doc",
"type": "string"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md doc"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"subcomponent": {
"$ref": "/opencomputeproject/ocp-diag-core/subcomponent",
"description": "TODO: link to md doc"
},
"unit": {
"description": "TODO: link to md doc",
"type": "string"
},
"validators": {
"description": "TODO: link to md doc",
"items": {
"$ref": "/opencomputeproject/ocp-diag-core/validator"
},
"type": "array"
}
},
"required": [
"name",
"measurementSeriesId"
],
"title": "Measurement series start"
} | MIT | en |
opencomputeproject/ocp-diag-core | e331694c6f150ab606ccc96413782f836b533eb6 | 2022-08-30T00:44:28 | json_spec/output/log.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"severity": {
"description": "TODO: link to md doc",
"enum": [
"INFO",
"DEBUG",
"WARNING",
"ERROR",
"FATAL"
],
"type": "string"
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/log",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"properties": {
"message": {
"description": "TODO: link to md doc",
"type": "string"
},
"severity": {
"$ref": "#/$defs/severity",
"description": "TODO: link to md doc"
}
},
"required": [
"severity",
"message"
],
"title": "Log"
} | MIT | en |
opencomputeproject/ocp-diag-core | 50465975e20dccfbd622471e4639a139a53706cd | 2023-02-22T03:18:19 | json_spec/output/log.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"severity": {
"description": "TODO: link to md doc",
"enum": [
"INFO",
"DEBUG",
"WARNING",
"ERROR",
"FATAL"
],
"type": "string"
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/log",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"message": {
"description": "TODO: link to md doc",
"type": "string"
},
"severity": {
"$ref": "#/$defs/severity",
"description": "TODO: link to md doc"
},
"sourceLocation": {
"$ref": "/opencomputeproject/ocp-diag-core/sourceLocation",
"description": "TODO: link to md doc"
}
},
"required": [
"severity",
"message"
],
"title": "Log"
} | MIT | en |
opencomputeproject/ocp-diag-core | b4d718dab6d287c3529846a19b87b8ee406fd628 | 2022-08-30T21:38:52 | json_spec/output/metadata.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/metadata",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"title": "Metadata",
"type": "object"
} | MIT | en |
opencomputeproject/ocp-diag-core | eb10e9d9b149c38e0d1a6df5e5c137f91d57f333 | 2022-08-30T23:50:50 | json_spec/output/test_run_artifact.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/testRunArtifact",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"oneOf": [
{
"properties": {
"testRunStart": {
"$ref": "/opencomputeproject/ocp-diag-core/testRunStart",
"description": "TODO: link to md"
}
},
"required": [
"testRunStart"
]
},
{
"properties": {
"testRunEnd": {
"$ref": "/opencomputeproject/ocp-diag-core/testRunEnd",
"description": "TODO: link to md"
}
},
"required": [
"testRunEnd"
]
},
{
"properties": {
"log": {
"$ref": "/opencomputeproject/ocp-diag-core/log",
"description": "TODO: link to md"
}
},
"required": [
"log"
]
},
{
"properties": {
"error": {
"$ref": "/opencomputeproject/ocp-diag-core/error",
"description": "TODO: link to md"
}
},
"required": [
"error"
]
}
],
"title": "Test run artifact"
} | MIT | en |
opencomputeproject/ocp-diag-core | 3a75d8938a2578acb2663db64ad7b480b6462a55 | 2022-08-30T23:50:53 | json_spec/output/measurement.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/measurement",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"properties": {
"hardwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md doc"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"subcomponent": {
"$ref": "/opencomputeproject/ocp-diag-core/subcomponent",
"description": "TODO: link to md doc"
},
"unit": {
"description": "TODO: link to md doc",
"type": "string"
},
"validators": {
"description": "TODO: link to md doc",
"items": {
"$ref": "/opencomputeproject/ocp-diag-core/validator"
},
"type": "array"
},
"value": {
"description": "TODO: link to md doc",
"type": [
"string",
"boolean",
"number"
]
}
},
"required": [
"name",
"value"
],
"title": "Measurement"
} | MIT | en |
opencomputeproject/ocp-diag-core | 10847108de11c6f4618b0b3a593eac8d5e70c096 | 2022-08-30T21:38:58 | json_spec/output/subcomponent.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"type": {
"description": "TODO: link to md doc",
"enum": [
"UNSPECIFIED",
"ASIC",
"ASIC-SUBSYSTEM",
"BUS",
"FUNCTION",
"CONNECTOR"
],
"type": "string"
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/subcomponent",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"properties": {
"location": {
"description": "TODO: link to md doc",
"type": "string"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"revision": {
"description": "TODO: link to md doc",
"type": "string"
},
"type": {
"$ref": "#/$defs/type",
"description": "TODO: link to md doc"
},
"version": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name"
],
"title": "Subcomponent"
} | MIT | en |
opencomputeproject/ocp-diag-core | 2ad6ade6e0946faf01bafacb500016f5d4ee9bbc | 2022-08-30T23:50:43 | json_spec/output/dut_info.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"hardwareInfo": {
"properties": {
"computerSystem": {
"description": "TODO: link to md doc",
"type": "string"
},
"hardwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"location": {
"description": "TODO: link to md doc",
"type": "string"
},
"manager": {
"description": "TODO: link to md doc",
"type": "string"
},
"manufacturer": {
"description": "TODO: link to md doc",
"type": "string"
},
"manufacturerPartNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"odataId": {
"description": "TODO: link to md doc",
"type": "string"
},
"partNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"partType": {
"description": "TODO: link to md doc",
"type": "string"
},
"revision": {
"description": "TODO: link to md doc",
"type": "string"
},
"serialNumber": {
"description": "TODO: link to md doc",
"type": "string"
},
"version": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name",
"hardwareInfoId"
]
},
"platformInfo": {
"properties": {
"info": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"info"
]
},
"softwareInfo": {
"properties": {
"computerSystem": {
"description": "TODO: link to md doc",
"type": "string"
},
"name": {
"description": "TODO: link to md doc",
"type": "string"
},
"revision": {
"description": "TODO: link to md doc",
"type": "string"
},
"softwareInfoId": {
"description": "TODO: link to md doc",
"type": "string"
},
"softwareType": {
"description": "TODO: link to md doc",
"enum": [
"UNSPECIFIED",
"FIRMWARE",
"SYSTEM",
"APPLICATION"
],
"type": "string"
},
"version": {
"description": "TODO: link to md doc",
"type": "string"
}
},
"required": [
"name",
"softwareInfoId"
]
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/dutInfo",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"properties": {
"hardwareInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/hardwareInfo"
},
"type": "array"
},
"hostname": {
"description": "TODO: link to md doc",
"type": "string"
},
"id": {
"description": "TODO: link to md doc",
"type": "string"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md doc"
},
"platformInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/platformInfo"
},
"type": "array"
},
"softwareInfos": {
"description": "TODO: link to md doc",
"items": {
"$ref": "#/$defs/softwareInfo"
},
"type": "array"
}
},
"required": [
"id"
],
"title": "Dut info"
} | MIT | en |
opencomputeproject/ocp-diag-core | 0cc951ded8268432eb806e417c0f8c381e9e19a8 | 2022-08-30T23:50:54 | json_spec/output/test_step_artifact.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"extension": {
"properties": {
"content": {
"description": "TODO: link to md",
"type": "object"
},
"name": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"name",
"content"
]
},
"file": {
"$comment": "file is just used in step artifact; extract when more usages appear",
"properties": {
"contentType": {
"description": "TODO: link to md",
"type": "string"
},
"description": {
"description": "TODO: link to md",
"type": "string"
},
"displayName": {
"description": "TODO: link to md",
"type": "string"
},
"isSnapshot": {
"description": "TODO: link to md",
"type": "boolean"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md"
},
"uri": {
"$comment": "maybe this should be more constrained",
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"displayName",
"uri",
"isSnapshot"
]
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/testStepArtifact",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"oneOf": [
{
"properties": {
"testStepStart": {
"$ref": "/opencomputeproject/ocp-diag-core/testStepStart",
"description": "TODO: link to md"
}
},
"required": [
"testStepStart"
]
},
{
"properties": {
"testStepEnd": {
"$ref": "/opencomputeproject/ocp-diag-core/testStepEnd",
"description": "TODO: link to md"
}
},
"required": [
"testStepEnd"
]
},
{
"properties": {
"measurement": {
"$ref": "/opencomputeproject/ocp-diag-core/measurement",
"description": "TODO: link to md"
}
},
"required": [
"measurement"
]
},
{
"properties": {
"measurementSeriesStart": {
"$ref": "/opencomputeproject/ocp-diag-core/measurementSeriesStart",
"description": "TODO: link to md"
}
},
"required": [
"measurementSeriesStart"
]
},
{
"properties": {
"measurementSeriesEnd": {
"$ref": "/opencomputeproject/ocp-diag-core/measurementSeriesEnd",
"description": "TODO: link to md"
}
},
"required": [
"measurementSeriesEnd"
]
},
{
"properties": {
"error": {
"$ref": "/opencomputeproject/ocp-diag-core/error",
"description": "TODO: link to md"
}
},
"required": [
"error"
]
},
{
"properties": {
"log": {
"$ref": "/opencomputeproject/ocp-diag-core/log",
"description": "TODO: link to md"
}
},
"required": [
"log"
]
},
{
"properties": {
"diagnosis": {
"$ref": "/opencomputeproject/ocp-diag-core/diagnosis",
"description": "TODO: link to md"
}
},
"required": [
"diagnosis"
]
},
{
"properties": {
"file": {
"$ref": "#/$defs/file"
}
},
"required": [
"file"
]
},
{
"properties": {
"extension": {
"$ref": "#/$defs/extension"
}
},
"required": [
"extension"
]
}
],
"properties": {
"testStepId": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"testStepId"
],
"title": "Step artifact"
} | MIT | en |
opencomputeproject/ocp-diag-core | 3a75d8938a2578acb2663db64ad7b480b6462a55 | 2022-08-30T23:50:53 | json_spec/output/test_step_artifact.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"extension": {
"properties": {
"content": {
"description": "TODO: link to md",
"type": "object"
},
"name": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"name",
"content"
]
},
"file": {
"$comment": "file is just used in step artifact; extract when more usages appear",
"properties": {
"contentType": {
"description": "TODO: link to md",
"type": "string"
},
"description": {
"description": "TODO: link to md",
"type": "string"
},
"displayName": {
"description": "TODO: link to md",
"type": "string"
},
"isSnapshot": {
"description": "TODO: link to md",
"type": "boolean"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md"
},
"uri": {
"$comment": "maybe this should be more constrained",
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"displayName",
"uri",
"isSnapshot"
]
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/testStepArtifact",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "TODO: link to md doc",
"oneOf": [
{
"properties": {
"testStepStart": {
"$ref": "/opencomputeproject/ocp-diag-core/testStepStart",
"description": "TODO: link to md"
}
},
"required": [
"testStepStart"
]
},
{
"properties": {
"testStepEnd": {
"$ref": "/opencomputeproject/ocp-diag-core/testStepEnd",
"description": "TODO: link to md"
}
},
"required": [
"testStepEnd"
]
},
{
"properties": {
"measurement": {
"$ref": "/opencomputeproject/ocp-diag-core/measurement",
"description": "TODO: link to md"
}
},
"required": [
"measurement"
]
},
{
"properties": {
"error": {
"$ref": "/opencomputeproject/ocp-diag-core/error",
"description": "TODO: link to md"
}
},
"required": [
"error"
]
},
{
"properties": {
"log": {
"$ref": "/opencomputeproject/ocp-diag-core/log",
"description": "TODO: link to md"
}
},
"required": [
"log"
]
},
{
"properties": {
"diagnosis": {
"$ref": "/opencomputeproject/ocp-diag-core/diagnosis",
"description": "TODO: link to md"
}
},
"required": [
"diagnosis"
]
},
{
"properties": {
"file": {
"$ref": "#/$defs/file"
}
},
"required": [
"file"
]
},
{
"properties": {
"extension": {
"$ref": "#/$defs/extension"
}
},
"required": [
"extension"
]
}
],
"properties": {
"testStepId": {
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"testStepId"
],
"title": "Step artifact"
} | MIT | en |
opencomputeproject/ocp-diag-core | 712f5a7daff0229418fdf052b3b6a4e667632c6d | 2022-08-30T23:50:56 | json_spec/output/log.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"severity": {
"description": "TODO: link to md doc",
"enum": [
"INFO",
"DEBUG",
"WARNING",
"ERROR",
"FATAL"
],
"type": "string"
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/log",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"message": {
"description": "TODO: link to md doc",
"type": "string"
},
"severity": {
"$ref": "#/$defs/severity",
"description": "TODO: link to md doc"
}
},
"required": [
"severity",
"message"
],
"title": "Log"
} | MIT | en |
opencomputeproject/ocp-diag-core | 712f5a7daff0229418fdf052b3b6a4e667632c6d | 2022-08-30T23:50:56 | json_spec/output/measurement_series_element.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$id": "https://github.com/opencomputeproject/ocp-diag-core/measurementSeriesElement",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "TODO: link to md doc",
"properties": {
"index": {
"description": "TODO: link to md doc",
"minimum": 0,
"type": "integer"
},
"measurementSeriesId": {
"description": "TODO: link to md doc",
"type": "string"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md doc"
},
"timestamp": {
"description": "TODO: link to spec md link",
"format": "date-time",
"type": "string"
},
"value": {
"description": "TODO: link to md doc",
"type": [
"string",
"boolean",
"number"
]
}
},
"required": [
"index",
"value",
"timestamp",
"measurementSeriesId"
],
"title": "Measurement series element"
} | MIT | en |
opencomputeproject/ocp-diag-core | 10847108de11c6f4618b0b3a593eac8d5e70c096 | 2022-08-30T21:38:58 | json_spec/output/test_step_artifact.json | 28 | 2024-05-28T05:47:44.39525Z | {
"$defs": {
"file": {
"$comment": "file is just used in step artifact; extract when more usages appear",
"properties": {
"contentType": {
"description": "TODO: link to md",
"type": "string"
},
"description": {
"description": "TODO: link to md",
"type": "string"
},
"displayName": {
"description": "TODO: link to md",
"type": "string"
},
"isSnapshot": {
"description": "TODO: link to md",
"type": "boolean"
},
"metadata": {
"$ref": "/opencomputeproject/ocp-diag-core/metadata",
"description": "TODO: link to md"
},
"uri": {
"$comment": "maybe this should be more constrained",
"description": "TODO: link to md",
"type": "string"
}
},
"required": [
"displayName",
"uri",
"isSnapshot"
]
}
},
"$id": "https://github.com/opencomputeproject/ocp-diag-core/testStepArtifact",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"required": [
"testStepId"
]
},
{
"oneOf": [
{
"required": [
"error"
]
},
{
"required": [
"log"
]
},
{
"required": [
"diagnosis"
]
},
{
"required": [
"file"
]
}
]
}
],
"description": "TODO: link to md doc",
"properties": {
"diagnosis": {
"$ref": "/opencomputeproject/ocp-diag-core/diagnosis",
"description": "TODO: link to md"
},
"error": {
"$ref": "/opencomputeproject/ocp-diag-core/error",
"description": "TODO: link to md"
},
"file": {
"$ref": "#/$defs/file"
},
"log": {
"$ref": "/opencomputeproject/ocp-diag-core/log",
"description": "TODO: link to md"
}
},
"title": "Step artifact"
} | MIT | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.