Skip to content

Instantly share code, notes, and snippets.

@heiko-braun
Created March 7, 2024 15:25
Show Gist options
  • Select an option

  • Save heiko-braun/27696d87f7c7408f8ee5d17c7342077f to your computer and use it in GitHub Desktop.

Select an option

Save heiko-braun/27696d87f7c7408f8ee5d17c7342077f to your computer and use it in GitHub Desktop.

Schema Docs

Type object
Required No
Additional properties [Not allowed]
1. [Optional] Property root > exportKubeConfig
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExportKubeConfig
1.1. [Optional] Property root > exportKubeConfig > context
Type string
Required No
1.2. [Optional] Property root > exportKubeConfig > server
Type string
Required No
1.3. [Optional] Property root > exportKubeConfig > secret
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SecretReference

Description: SecretReference represents a Secret Reference.

1.3.1. [Optional] Property root > exportKubeConfig > secret > name
Type string
Required No

Description: name is unique within a namespace to reference a secret resource.

1.3.2. [Optional] Property root > exportKubeConfig > secret > namespace
Type string
Required No

Description: namespace defines the space within which the secret name must be unique.

2. [Optional] Property root > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Sync
2.1. [Optional] Property root > sync > ToHost
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncToHost
2.1.1. [Optional] Property root > sync > ToHost > services
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.1.1. [Optional] Property root > sync > ToHost > services > enabled
Type boolean
Required No
2.1.2. [Optional] Property root > sync > ToHost > endpoints
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.2.1. [Optional] Property root > sync > ToHost > endpoints > enabled
Type boolean
Required No
2.1.3. [Optional] Property root > sync > ToHost > ingresses
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.3.1. [Optional] Property root > sync > ToHost > ingresses > enabled
Type boolean
Required No
2.1.4. [Optional] Property root > sync > ToHost > priorityClasses
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.4.1. [Optional] Property root > sync > ToHost > priorityClasses > enabled
Type boolean
Required No
2.1.5. [Optional] Property root > sync > ToHost > networkPolicies
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.5.1. [Optional] Property root > sync > ToHost > networkPolicies > enabled
Type boolean
Required No
2.1.6. [Optional] Property root > sync > ToHost > volumeSnapshots
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.6.1. [Optional] Property root > sync > ToHost > volumeSnapshots > enabled
Type boolean
Required No
2.1.7. [Optional] Property root > sync > ToHost > podDisruptionBudgets
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.7.1. [Optional] Property root > sync > ToHost > podDisruptionBudgets > enabled
Type boolean
Required No
2.1.8. [Optional] Property root > sync > ToHost > serviceAccounts
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.8.1. [Optional] Property root > sync > ToHost > serviceAccounts > enabled
Type boolean
Required No
2.1.9. [Optional] Property root > sync > ToHost > storageClasses
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.9.1. [Optional] Property root > sync > ToHost > storageClasses > enabled
Type boolean
Required No
2.1.10. [Optional] Property root > sync > ToHost > persistentVolumes
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.10.1. [Optional] Property root > sync > ToHost > persistentVolumes > enabled
Type boolean
Required No
2.1.11. [Optional] Property root > sync > ToHost > persistentVolumeClaims
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.1.11.1. [Optional] Property root > sync > ToHost > persistentVolumeClaims > enabled
Type boolean
Required No
2.1.12. [Optional] Property root > sync > ToHost > configMaps
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncAllResource
2.1.12.1. [Optional] Property root > sync > ToHost > configMaps > enabled
Type boolean
Required No
2.1.13. [Optional] Property root > sync > ToHost > secrets
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncAllResource
2.1.13.1. [Optional] Property root > sync > ToHost > secrets > enabled
Type boolean
Required No
2.1.14. [Optional] Property root > sync > ToHost > pods
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncPods
2.1.14.1. [Optional] Property root > sync > ToHost > pods > enabled
Type boolean
Required No
2.1.14.2. [Optional] Property root > sync > ToHost > pods > workloadServiceAccount
Type string
Required No
2.1.14.3. [Optional] Property root > sync > ToHost > pods > translateImage
Type object
Required No
Additional properties [Should-conform]
2.1.14.3.1. Property root > sync > ToHost > pods > translateImage > additionalProperties
Type string
Required No
2.1.14.4. [Optional] Property root > sync > ToHost > pods > enforceTolerations
Type array of string
Required No

Description: validate format

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
enforceTolerations items -
2.1.14.4.1. root > sync > ToHost > pods > enforceTolerations > enforceTolerations items
Type string
Required No
2.1.14.5. [Optional] Property root > sync > ToHost > pods > useSecretsForSATokens
Type boolean
Required No
2.1.14.6. [Optional] Property root > sync > ToHost > pods > rewriteHosts
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncRewriteHosts
2.1.14.6.1. [Optional] Property root > sync > ToHost > pods > rewriteHosts > enabled
Type boolean
Required No
2.1.14.6.2. [Optional] Property root > sync > ToHost > pods > rewriteHosts > initContainerImage
Type boolean
Required No
2.2. [Optional] Property root > sync > FromHost
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncFromHost
2.2.1. [Optional] Property root > sync > FromHost > csiDrivers
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.2.1.1. [Optional] Property root > sync > FromHost > csiDrivers > enabled
Type boolean
Required No
2.2.2. [Optional] Property root > sync > FromHost > csiNodes
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.2.2.1. [Optional] Property root > sync > FromHost > csiNodes > enabled
Type boolean
Required No
2.2.3. [Optional] Property root > sync > FromHost > csiStorageCapacities
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.2.3.1. [Optional] Property root > sync > FromHost > csiStorageCapacities > enabled
Type boolean
Required No
2.2.4. [Optional] Property root > sync > FromHost > ingressClasses
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.2.4.1. [Optional] Property root > sync > FromHost > ingressClasses > enabled
Type boolean
Required No
2.2.5. [Optional] Property root > sync > FromHost > events
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.2.5.1. [Optional] Property root > sync > FromHost > events > enabled
Type boolean
Required No
2.2.6. [Optional] Property root > sync > FromHost > storageClasses
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.2.6.1. [Optional] Property root > sync > FromHost > storageClasses > enabled
Type boolean
Required No
2.2.7. [Optional] Property root > sync > FromHost > nodes
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncNodes
2.2.7.1. [Optional] Property root > sync > FromHost > nodes > real
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncRealNodes
2.2.7.1.1. [Optional] Property root > sync > FromHost > nodes > real > enabled
Type boolean
Required No
2.2.7.1.2. [Optional] Property root > sync > FromHost > nodes > real > syncLabelsTaints
Type boolean
Required No
2.2.7.1.3. [Optional] Property root > sync > FromHost > nodes > real > clearImageStatus
Type boolean
Required No
2.2.7.1.4. [Optional] Property root > sync > FromHost > nodes > real > selector
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncNodeSelector
2.2.7.1.4.1. [Optional] Property root > sync > FromHost > nodes > real > selector > label
Type object
Required No
Additional properties [Should-conform]
2.2.7.1.4.1.1. Property root > sync > FromHost > nodes > real > selector > label > additionalProperties
Type string
Required No
2.2.7.2. [Optional] Property root > sync > FromHost > nodes > pseudo
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
2.2.7.2.1. [Optional] Property root > sync > FromHost > nodes > pseudo > enabled
Type boolean
Required No
3. [Optional] Property root > observability
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Observability
3.1. [Optional] Property root > observability > serviceMonitor
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
3.1.1. [Optional] Property root > observability > serviceMonitor > enabled
Type boolean
Required No
3.2. [Optional] Property root > observability > metrics
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ObservabilityMetrics
3.2.1. [Optional] Property root > observability > metrics > proxy
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/MetricsProxy
3.2.1.1. [Optional] Property root > observability > metrics > proxy > nodes
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
3.2.1.1.1. [Optional] Property root > observability > metrics > proxy > nodes > enabled
Type boolean
Required No
3.2.1.2. [Optional] Property root > observability > metrics > proxy > pods
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
3.2.1.2.1. [Optional] Property root > observability > metrics > proxy > pods > enabled
Type boolean
Required No
4. [Optional] Property root > networking
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Networking
4.1. [Optional] Property root > networking > replicateServices
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ReplicateServices
4.1.1. [Optional] Property root > networking > replicateServices > toHost
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ServiceMapping
4.1.1.1. [Optional] Property root > networking > replicateServices > toHost > from
Type string
Required No
4.1.1.2. [Optional] Property root > networking > replicateServices > toHost > to
Type string
Required No
4.1.2. [Optional] Property root > networking > replicateServices > fromHost
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ServiceMapping
4.1.2.1. [Optional] Property root > networking > replicateServices > fromHost > from
Type string
Required No
4.1.2.2. [Optional] Property root > networking > replicateServices > fromHost > to
Type string
Required No
4.2. [Optional] Property root > networking > resolveServices
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ResolveServices
4.2.1. [Optional] Property root > networking > resolveServices > service
Type string
Required No
4.2.2. [Optional] Property root > networking > resolveServices > target
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ResolveServiceTarget
4.2.2.1. [Optional] Property root > networking > resolveServices > target > vcluster
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ResolveServiceService
4.2.2.1.1. [Optional] Property root > networking > resolveServices > target > vcluster > service
Type string
Required No
4.2.2.2. [Optional] Property root > networking > resolveServices > target > host
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ResolveServiceService
4.2.2.2.1. [Optional] Property root > networking > resolveServices > target > host > service
Type string
Required No
4.2.2.3. [Optional] Property root > networking > resolveServices > target > external
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ResolveServiceHostname
4.2.2.3.1. [Optional] Property root > networking > resolveServices > target > external > hostname
Type string
Required No
4.3. [Optional] Property root > networking > advanced
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/NetworkingAdvanced
4.3.1. [Optional] Property root > networking > advanced > clusterDomain
Type string
Required No
4.3.2. [Optional] Property root > networking > advanced > fallback
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
NetworkDNSFallback -
4.3.2.1. root > networking > advanced > fallback > NetworkDNSFallback
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/NetworkDNSFallback
4.3.2.1.1. [Optional] Property root > networking > advanced > fallback > fallback items > ip
Type string
Required No
4.3.2.1.2. [Optional] Property root > networking > advanced > fallback > fallback items > hostCluster
Type boolean
Required No
4.3.3. [Optional] Property root > networking > advanced > proxyKubelets
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/NetworkProxyKubelets
4.3.3.1. [Optional] Property root > networking > advanced > proxyKubelets > byHostname
Type boolean
Required No
4.3.3.2. [Optional] Property root > networking > advanced > proxyKubelets > byIP
Type boolean
Required No
5. [Optional] Property root > plugin
Type combining
Required No
Additional properties [Should-conform]
Any of(Option)
item 0
item 1
item 2

5.1. Property root > plugin > anyOf > item 0

Type object
Required No
Additional properties [Any type: allowed]
5.1.1. [Optional]Pattern Property root > plugin > anyOf > item 0 > .* > All properties whose name matches the regular expression ```.*``` ([Test](https://regex101.com/?regex=.%2A)) must respect the following conditions
Type string
Required No

5.2. Property root > plugin > anyOf > item 1

Type object
Required No
Additional properties [Any type: allowed]

5.3. Property root > plugin > anyOf > item 2

Type object
Required No
Additional properties [Any type: allowed]
5.4. Property root > plugin > Plugin
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Plugin
5.4.1. [Optional] Property root > plugin > additionalProperties > image
Type string
Required No
5.4.2. [Optional] Property root > plugin > additionalProperties > config
Type object
Required No
Additional properties [Any type: allowed]
5.4.3. [Optional] Property root > plugin > additionalProperties > rbac
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PluginsRBAC
5.4.3.1. [Optional] Property root > plugin > additionalProperties > rbac > role
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
RBACPolicyRule -
5.4.3.1.1. root > plugin > additionalProperties > rbac > role > RBACPolicyRule
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/RBACPolicyRule
5.4.3.1.1.1. [Optional] Property root > plugin > additionalProperties > rbac > role > role items > verbs
Type array of string
Required No

Description: Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
5.4.3.1.1.1.1. root > plugin > additionalProperties > rbac > role > role items > verbs > verbs items
Type string
Required No
5.4.3.1.1.2. [Optional] Property root > plugin > additionalProperties > rbac > role > role items > apiGroups
Type array of string
Required No

Description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
apiGroups items -
5.4.3.1.1.2.1. root > plugin > additionalProperties > rbac > role > role items > apiGroups > apiGroups items
Type string
Required No
5.4.3.1.1.3. [Optional] Property root > plugin > additionalProperties > rbac > role > role items > resources
Type array of string
Required No

Description: Resources is a list of resources this rule applies to. '*' represents all resources.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resources items -
5.4.3.1.1.3.1. root > plugin > additionalProperties > rbac > role > role items > resources > resources items
Type string
Required No
5.4.3.1.1.4. [Optional] Property root > plugin > additionalProperties > rbac > role > role items > resourceNames
Type array of string
Required No

Description: ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resourceNames items -
5.4.3.1.1.4.1. root > plugin > additionalProperties > rbac > role > role items > resourceNames > resourceNames items
Type string
Required No
5.4.3.1.1.5. [Optional] Property root > plugin > additionalProperties > rbac > role > role items > nonResourceURLs
Type array of string
Required No

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 Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
nonResourceURLs items -
5.4.3.1.1.5.1. root > plugin > additionalProperties > rbac > role > role items > nonResourceURLs > nonResourceURLs items
Type string
Required No
5.4.3.2. [Optional] Property root > plugin > additionalProperties > rbac > clusterRole
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
RBACPolicyRule -
5.4.3.2.1. root > plugin > additionalProperties > rbac > clusterRole > RBACPolicyRule
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/RBACPolicyRule
5.4.3.2.1.1. [Optional] Property root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > verbs
Type array of string
Required No

Description: Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
5.4.3.2.1.1.1. root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > verbs > verbs items
Type string
Required No
5.4.3.2.1.2. [Optional] Property root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > apiGroups
Type array of string
Required No

Description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
apiGroups items -
5.4.3.2.1.2.1. root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > apiGroups > apiGroups items
Type string
Required No
5.4.3.2.1.3. [Optional] Property root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > resources
Type array of string
Required No

Description: Resources is a list of resources this rule applies to. '*' represents all resources.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resources items -
5.4.3.2.1.3.1. root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > resources > resources items
Type string
Required No
5.4.3.2.1.4. [Optional] Property root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > resourceNames
Type array of string
Required No

Description: ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resourceNames items -
5.4.3.2.1.4.1. root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > resourceNames > resourceNames items
Type string
Required No
5.4.3.2.1.5. [Optional] Property root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > nonResourceURLs
Type array of string
Required No

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 Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
nonResourceURLs items -
5.4.3.2.1.5.1. root > plugin > additionalProperties > rbac > clusterRole > clusterRole items > nonResourceURLs > nonResourceURLs items
Type string
Required No
5.4.4. [Optional] Property root > plugin > additionalProperties > version
Type string
Required No
6. [Optional] Property root > plugins
Type combining
Required No
Additional properties [Should-conform]
Any of(Option)
item 0
item 1
item 2

6.1. Property root > plugins > anyOf > item 0

Type object
Required No
Additional properties [Any type: allowed]
6.1.1. [Optional]Pattern Property root > plugins > anyOf > item 0 > .* > All properties whose name matches the regular expression ```.*``` ([Test](https://regex101.com/?regex=.%2A)) must respect the following conditions
Type string
Required No

6.2. Property root > plugins > anyOf > item 1

Type object
Required No
Additional properties [Any type: allowed]

6.3. Property root > plugins > anyOf > item 2

Type object
Required No
Additional properties [Any type: allowed]
6.4. Property root > plugins > Plugins
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Plugins
6.4.1. [Optional] Property root > plugins > additionalProperties > image
Type string
Required No
6.4.2. [Optional] Property root > plugins > additionalProperties > config
Type object
Required No
Additional properties [Any type: allowed]
6.4.3. [Optional] Property root > plugins > additionalProperties > rbac
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PluginsRBAC
6.4.3.1. [Optional] Property root > plugins > additionalProperties > rbac > role
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
RBACPolicyRule -
6.4.3.1.1. root > plugins > additionalProperties > rbac > role > RBACPolicyRule
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/RBACPolicyRule
6.4.3.1.1.1. [Optional] Property root > plugins > additionalProperties > rbac > role > role items > verbs
Type array of string
Required No

Description: Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
6.4.3.1.1.1.1. root > plugins > additionalProperties > rbac > role > role items > verbs > verbs items
Type string
Required No
6.4.3.1.1.2. [Optional] Property root > plugins > additionalProperties > rbac > role > role items > apiGroups
Type array of string
Required No

Description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
apiGroups items -
6.4.3.1.1.2.1. root > plugins > additionalProperties > rbac > role > role items > apiGroups > apiGroups items
Type string
Required No
6.4.3.1.1.3. [Optional] Property root > plugins > additionalProperties > rbac > role > role items > resources
Type array of string
Required No

Description: Resources is a list of resources this rule applies to. '*' represents all resources.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resources items -
6.4.3.1.1.3.1. root > plugins > additionalProperties > rbac > role > role items > resources > resources items
Type string
Required No
6.4.3.1.1.4. [Optional] Property root > plugins > additionalProperties > rbac > role > role items > resourceNames
Type array of string
Required No

Description: ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resourceNames items -
6.4.3.1.1.4.1. root > plugins > additionalProperties > rbac > role > role items > resourceNames > resourceNames items
Type string
Required No
6.4.3.1.1.5. [Optional] Property root > plugins > additionalProperties > rbac > role > role items > nonResourceURLs
Type array of string
Required No

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 Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
nonResourceURLs items -
6.4.3.1.1.5.1. root > plugins > additionalProperties > rbac > role > role items > nonResourceURLs > nonResourceURLs items
Type string
Required No
6.4.3.2. [Optional] Property root > plugins > additionalProperties > rbac > clusterRole
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
RBACPolicyRule -
6.4.3.2.1. root > plugins > additionalProperties > rbac > clusterRole > RBACPolicyRule
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/RBACPolicyRule
6.4.3.2.1.1. [Optional] Property root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > verbs
Type array of string
Required No

Description: Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
6.4.3.2.1.1.1. root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > verbs > verbs items
Type string
Required No
6.4.3.2.1.2. [Optional] Property root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > apiGroups
Type array of string
Required No

Description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
apiGroups items -
6.4.3.2.1.2.1. root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > apiGroups > apiGroups items
Type string
Required No
6.4.3.2.1.3. [Optional] Property root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > resources
Type array of string
Required No

Description: Resources is a list of resources this rule applies to. '*' represents all resources.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resources items -
6.4.3.2.1.3.1. root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > resources > resources items
Type string
Required No
6.4.3.2.1.4. [Optional] Property root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > resourceNames
Type array of string
Required No

Description: ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
resourceNames items -
6.4.3.2.1.4.1. root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > resourceNames > resourceNames items
Type string
Required No
6.4.3.2.1.5. [Optional] Property root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > nonResourceURLs
Type array of string
Required No

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 Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
nonResourceURLs items -
6.4.3.2.1.5.1. root > plugins > additionalProperties > rbac > clusterRole > clusterRole items > nonResourceURLs > nonResourceURLs items
Type string
Required No
7. [Optional] Property root > controlPlane
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlane
7.1. [Optional] Property root > controlPlane > distro
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Distro
7.1.1. [Optional] Property root > controlPlane > distro > k3s
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroK3s
7.1.1.1. [Optional] Property root > controlPlane > distro > k3s > enabled
Type boolean
Required No
7.1.1.2. [Optional] Property root > controlPlane > distro > k3s > spec
Type object
Required No
Additional properties [Any type: allowed]
7.1.1.3. [Optional] Property root > controlPlane > distro > k3s > image
Type string
Required No
7.1.1.4. [Optional] Property root > controlPlane > distro > k3s > imagePullPolicy
Type string
Required No
7.1.1.5. [Optional] Property root > controlPlane > distro > k3s > command
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
command items -
7.1.1.5.1. root > controlPlane > distro > k3s > command > command items
Type string
Required No
7.1.1.6. [Optional] Property root > controlPlane > distro > k3s > args
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
args items -
7.1.1.6.1. root > controlPlane > distro > k3s > args > args items
Type string
Required No
7.1.1.7. [Optional] Property root > controlPlane > distro > k3s > extraArgs
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
extraArgs items -
7.1.1.7.1. root > controlPlane > distro > k3s > extraArgs > extraArgs items
Type string
Required No
7.1.1.8. [Optional] Property root > controlPlane > distro > k3s > env
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
env items -
7.1.1.8.1. root > controlPlane > distro > k3s > env > env items
Type object
Required No
Additional properties [Any type: allowed]
7.1.1.9. [Optional] Property root > controlPlane > distro > k3s > token
Type string
Required No
7.1.1.10. [Optional] Property root > controlPlane > distro > k3s > backingStore
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/BackingStore
7.1.1.10.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > embeddedEtcd
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EmbeddedEtcd
7.1.1.10.1.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > embeddedEtcd > enabled
Type boolean
Required No
7.1.1.10.1.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > embeddedEtcd > migrateFromSqlite
Type boolean
Required No
7.1.1.10.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExternalEtcd
7.1.1.10.2.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > enabled
Type boolean
Required No
7.1.1.10.2.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > image
Type string
Required No
7.1.1.10.2.3. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > replicas
Type integer
Required No
7.1.1.10.2.4. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > security
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneSecurity
7.1.1.10.2.4.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > security > podSecurityContext
Type object
Required No
Additional properties [Any type: allowed]
7.1.1.10.2.4.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > security > containerSecurityContext
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneContainerSecurityContext
7.1.1.10.2.4.2.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > security > containerSecurityContext > allowPrivilegeEscalation
Type boolean
Required No
7.1.1.10.2.4.2.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > security > containerSecurityContext > capabilities
Type object
Required No
Additional properties [Any type: allowed]
7.1.1.10.2.4.2.3. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > security > containerSecurityContext > runAsUser
Type integer
Required No
7.1.1.10.2.4.2.4. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > security > containerSecurityContext > runAsGroup
Type integer
Required No
7.1.1.10.2.5. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > scheduling
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneScheduling
7.1.1.10.2.5.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > scheduling > nodeSelector
Type object
Required No
Additional properties [Any type: allowed]
7.1.1.10.2.5.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > scheduling > affinity
Type object
Required No
Additional properties [Any type: allowed]
7.1.1.10.2.5.3. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > scheduling > tolerations
Type object
Required No
Additional properties [Any type: allowed]
7.1.1.10.2.5.4. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > scheduling > priorityClassName
Type string
Required No
7.1.1.10.2.6. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlanePersistence
7.1.1.10.2.6.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > enabled
Type boolean
Required No
7.1.1.10.2.6.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > retentionPolicy
Type string
Required No
7.1.1.10.2.6.3. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > size
Type string
Required No
7.1.1.10.2.6.4. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > storageClass
Type string
Required No
7.1.1.10.2.6.5. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.1.1.10.2.6.5.1. root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.1.1.10.2.6.5.1.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.1.1.10.2.6.5.1.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.1.1.10.2.6.5.1.3. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.1.1.10.2.6.5.1.4. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.1.1.10.2.6.5.1.5. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.1.1.10.2.6.5.1.6. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.1.1.10.2.6.6. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.1.1.10.2.6.6.1. root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.1.1.10.2.6.6.1.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.1.1.10.2.6.6.1.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.1.1.10.2.6.6.1.3. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.1.1.10.2.6.6.1.4. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.1.1.10.2.6.6.1.5. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.1.1.10.2.6.6.1.6. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.1.1.10.2.7. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExternalEtcdMetadata
7.1.1.10.2.7.1. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > labels
Type object
Required No
Additional properties [Should-conform]
7.1.1.10.2.7.1.1. Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > labels > additionalProperties
Type string
Required No
7.1.1.10.2.7.2. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > annotations
Type object
Required No
Additional properties [Should-conform]
7.1.1.10.2.7.2.1. Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > annotations > additionalProperties
Type string
Required No
7.1.1.10.2.7.3. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > podLabels
Type object
Required No
Additional properties [Should-conform]
7.1.1.10.2.7.3.1. Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > podLabels > additionalProperties
Type string
Required No
7.1.1.10.2.7.4. [Optional] Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > podAnnotations
Type object
Required No
Additional properties [Should-conform]
7.1.1.10.2.7.4.1. Property root > controlPlane > distro > k3s > backingStore > externalEtcd > metadata > podAnnotations > additionalProperties
Type string
Required No
7.1.2. [Optional] Property root > controlPlane > distro > k8s
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroK8s
7.1.2.1. [Optional] Property root > controlPlane > distro > k8s > enabled
Type boolean
Required No
7.1.2.2. [Optional] Property root > controlPlane > distro > k8s > apiServer
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroContainer
7.1.2.2.1. [Optional] Property root > controlPlane > distro > k8s > apiServer > spec
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.2.2. [Optional] Property root > controlPlane > distro > k8s > apiServer > image
Type string
Required No
7.1.2.2.3. [Optional] Property root > controlPlane > distro > k8s > apiServer > imagePullPolicy
Type string
Required No
7.1.2.2.4. [Optional] Property root > controlPlane > distro > k8s > apiServer > command
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
command items -
7.1.2.2.4.1. root > controlPlane > distro > k8s > apiServer > command > command items
Type string
Required No
7.1.2.2.5. [Optional] Property root > controlPlane > distro > k8s > apiServer > args
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
args items -
7.1.2.2.5.1. root > controlPlane > distro > k8s > apiServer > args > args items
Type string
Required No
7.1.2.2.6. [Optional] Property root > controlPlane > distro > k8s > apiServer > extraArgs
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
extraArgs items -
7.1.2.2.6.1. root > controlPlane > distro > k8s > apiServer > extraArgs > extraArgs items
Type string
Required No
7.1.2.2.7. [Optional] Property root > controlPlane > distro > k8s > apiServer > env
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
env items -
7.1.2.2.7.1. root > controlPlane > distro > k8s > apiServer > env > env items
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.3. [Optional] Property root > controlPlane > distro > k8s > controllerManager
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroContainer
7.1.2.3.1. [Optional] Property root > controlPlane > distro > k8s > controllerManager > spec
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.3.2. [Optional] Property root > controlPlane > distro > k8s > controllerManager > image
Type string
Required No
7.1.2.3.3. [Optional] Property root > controlPlane > distro > k8s > controllerManager > imagePullPolicy
Type string
Required No
7.1.2.3.4. [Optional] Property root > controlPlane > distro > k8s > controllerManager > command
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
command items -
7.1.2.3.4.1. root > controlPlane > distro > k8s > controllerManager > command > command items
Type string
Required No
7.1.2.3.5. [Optional] Property root > controlPlane > distro > k8s > controllerManager > args
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
args items -
7.1.2.3.5.1. root > controlPlane > distro > k8s > controllerManager > args > args items
Type string
Required No
7.1.2.3.6. [Optional] Property root > controlPlane > distro > k8s > controllerManager > extraArgs
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
extraArgs items -
7.1.2.3.6.1. root > controlPlane > distro > k8s > controllerManager > extraArgs > extraArgs items
Type string
Required No
7.1.2.3.7. [Optional] Property root > controlPlane > distro > k8s > controllerManager > env
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
env items -
7.1.2.3.7.1. root > controlPlane > distro > k8s > controllerManager > env > env items
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.4. [Optional] Property root > controlPlane > distro > k8s > scheduler
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroContainer
7.1.2.4.1. [Optional] Property root > controlPlane > distro > k8s > scheduler > spec
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.4.2. [Optional] Property root > controlPlane > distro > k8s > scheduler > image
Type string
Required No
7.1.2.4.3. [Optional] Property root > controlPlane > distro > k8s > scheduler > imagePullPolicy
Type string
Required No
7.1.2.4.4. [Optional] Property root > controlPlane > distro > k8s > scheduler > command
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
command items -
7.1.2.4.4.1. root > controlPlane > distro > k8s > scheduler > command > command items
Type string
Required No
7.1.2.4.5. [Optional] Property root > controlPlane > distro > k8s > scheduler > args
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
args items -
7.1.2.4.5.1. root > controlPlane > distro > k8s > scheduler > args > args items
Type string
Required No
7.1.2.4.6. [Optional] Property root > controlPlane > distro > k8s > scheduler > extraArgs
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
extraArgs items -
7.1.2.4.6.1. root > controlPlane > distro > k8s > scheduler > extraArgs > extraArgs items
Type string
Required No
7.1.2.4.7. [Optional] Property root > controlPlane > distro > k8s > scheduler > env
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
env items -
7.1.2.4.7.1. root > controlPlane > distro > k8s > scheduler > env > env items
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.5. [Optional] Property root > controlPlane > distro > k8s > backingStore
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/BackingStore
7.1.2.5.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > embeddedEtcd
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EmbeddedEtcd
7.1.2.5.1.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > embeddedEtcd > enabled
Type boolean
Required No
7.1.2.5.1.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > embeddedEtcd > migrateFromSqlite
Type boolean
Required No
7.1.2.5.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExternalEtcd
7.1.2.5.2.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > enabled
Type boolean
Required No
7.1.2.5.2.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > image
Type string
Required No
7.1.2.5.2.3. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > replicas
Type integer
Required No
7.1.2.5.2.4. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > security
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneSecurity
7.1.2.5.2.4.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > security > podSecurityContext
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.5.2.4.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > security > containerSecurityContext
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneContainerSecurityContext
7.1.2.5.2.4.2.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > security > containerSecurityContext > allowPrivilegeEscalation
Type boolean
Required No
7.1.2.5.2.4.2.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > security > containerSecurityContext > capabilities
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.5.2.4.2.3. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > security > containerSecurityContext > runAsUser
Type integer
Required No
7.1.2.5.2.4.2.4. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > security > containerSecurityContext > runAsGroup
Type integer
Required No
7.1.2.5.2.5. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > scheduling
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneScheduling
7.1.2.5.2.5.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > scheduling > nodeSelector
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.5.2.5.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > scheduling > affinity
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.5.2.5.3. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > scheduling > tolerations
Type object
Required No
Additional properties [Any type: allowed]
7.1.2.5.2.5.4. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > scheduling > priorityClassName
Type string
Required No
7.1.2.5.2.6. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlanePersistence
7.1.2.5.2.6.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > enabled
Type boolean
Required No
7.1.2.5.2.6.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > retentionPolicy
Type string
Required No
7.1.2.5.2.6.3. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > size
Type string
Required No
7.1.2.5.2.6.4. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > storageClass
Type string
Required No
7.1.2.5.2.6.5. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.1.2.5.2.6.5.1. root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.1.2.5.2.6.5.1.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.1.2.5.2.6.5.1.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.1.2.5.2.6.5.1.3. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.1.2.5.2.6.5.1.4. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.1.2.5.2.6.5.1.5. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.1.2.5.2.6.5.1.6. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.1.2.5.2.6.6. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.1.2.5.2.6.6.1. root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.1.2.5.2.6.6.1.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.1.2.5.2.6.6.1.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.1.2.5.2.6.6.1.3. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.1.2.5.2.6.6.1.4. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.1.2.5.2.6.6.1.5. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.1.2.5.2.6.6.1.6. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.1.2.5.2.7. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExternalEtcdMetadata
7.1.2.5.2.7.1. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > labels
Type object
Required No
Additional properties [Should-conform]
7.1.2.5.2.7.1.1. Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > labels > additionalProperties
Type string
Required No
7.1.2.5.2.7.2. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > annotations
Type object
Required No
Additional properties [Should-conform]
7.1.2.5.2.7.2.1. Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > annotations > additionalProperties
Type string
Required No
7.1.2.5.2.7.3. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > podLabels
Type object
Required No
Additional properties [Should-conform]
7.1.2.5.2.7.3.1. Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > podLabels > additionalProperties
Type string
Required No
7.1.2.5.2.7.4. [Optional] Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > podAnnotations
Type object
Required No
Additional properties [Should-conform]
7.1.2.5.2.7.4.1. Property root > controlPlane > distro > k8s > backingStore > externalEtcd > metadata > podAnnotations > additionalProperties
Type string
Required No
7.1.3. [Optional] Property root > controlPlane > distro > k0s
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroK0s
7.1.3.1. [Optional] Property root > controlPlane > distro > k0s > enabled
Type boolean
Required No
7.1.3.2. [Optional] Property root > controlPlane > distro > k0s > backingStore
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/BackingStore
7.1.3.2.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > embeddedEtcd
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EmbeddedEtcd
7.1.3.2.1.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > embeddedEtcd > enabled
Type boolean
Required No
7.1.3.2.1.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > embeddedEtcd > migrateFromSqlite
Type boolean
Required No
7.1.3.2.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExternalEtcd
7.1.3.2.2.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > enabled
Type boolean
Required No
7.1.3.2.2.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > image
Type string
Required No
7.1.3.2.2.3. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > replicas
Type integer
Required No
7.1.3.2.2.4. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > security
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneSecurity
7.1.3.2.2.4.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > security > podSecurityContext
Type object
Required No
Additional properties [Any type: allowed]
7.1.3.2.2.4.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > security > containerSecurityContext
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneContainerSecurityContext
7.1.3.2.2.4.2.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > security > containerSecurityContext > allowPrivilegeEscalation
Type boolean
Required No
7.1.3.2.2.4.2.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > security > containerSecurityContext > capabilities
Type object
Required No
Additional properties [Any type: allowed]
7.1.3.2.2.4.2.3. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > security > containerSecurityContext > runAsUser
Type integer
Required No
7.1.3.2.2.4.2.4. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > security > containerSecurityContext > runAsGroup
Type integer
Required No
7.1.3.2.2.5. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > scheduling
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneScheduling
7.1.3.2.2.5.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > scheduling > nodeSelector
Type object
Required No
Additional properties [Any type: allowed]
7.1.3.2.2.5.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > scheduling > affinity
Type object
Required No
Additional properties [Any type: allowed]
7.1.3.2.2.5.3. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > scheduling > tolerations
Type object
Required No
Additional properties [Any type: allowed]
7.1.3.2.2.5.4. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > scheduling > priorityClassName
Type string
Required No
7.1.3.2.2.6. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlanePersistence
7.1.3.2.2.6.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > enabled
Type boolean
Required No
7.1.3.2.2.6.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > retentionPolicy
Type string
Required No
7.1.3.2.2.6.3. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > size
Type string
Required No
7.1.3.2.2.6.4. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > storageClass
Type string
Required No
7.1.3.2.2.6.5. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.1.3.2.2.6.5.1. root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.1.3.2.2.6.5.1.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.1.3.2.2.6.5.1.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.1.3.2.2.6.5.1.3. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.1.3.2.2.6.5.1.4. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.1.3.2.2.6.5.1.5. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.1.3.2.2.6.5.1.6. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > addVolumeMounts > addVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.1.3.2.2.6.6. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.1.3.2.2.6.6.1. root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.1.3.2.2.6.6.1.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.1.3.2.2.6.6.1.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.1.3.2.2.6.6.1.3. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.1.3.2.2.6.6.1.4. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.1.3.2.2.6.6.1.5. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.1.3.2.2.6.6.1.6. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.1.3.2.2.7. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExternalEtcdMetadata
7.1.3.2.2.7.1. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > labels
Type object
Required No
Additional properties [Should-conform]
7.1.3.2.2.7.1.1. Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > labels > additionalProperties
Type string
Required No
7.1.3.2.2.7.2. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > annotations
Type object
Required No
Additional properties [Should-conform]
7.1.3.2.2.7.2.1. Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > annotations > additionalProperties
Type string
Required No
7.1.3.2.2.7.3. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > podLabels
Type object
Required No
Additional properties [Should-conform]
7.1.3.2.2.7.3.1. Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > podLabels > additionalProperties
Type string
Required No
7.1.3.2.2.7.4. [Optional] Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > podAnnotations
Type object
Required No
Additional properties [Should-conform]
7.1.3.2.2.7.4.1. Property root > controlPlane > distro > k0s > backingStore > externalEtcd > metadata > podAnnotations > additionalProperties
Type string
Required No
7.1.4. [Optional] Property root > controlPlane > distro > advanced
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroAdvanced
7.1.4.1. [Optional] Property root > controlPlane > distro > advanced > paths
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/DistroPaths
7.1.4.1.1. [Optional] Property root > controlPlane > distro > advanced > paths > kubeConfig
Type string
Required No
7.1.4.1.2. [Optional] Property root > controlPlane > distro > advanced > paths > serverCAKey
Type string
Required No
7.1.4.1.3. [Optional] Property root > controlPlane > distro > advanced > paths > serverCACert
Type string
Required No
7.1.4.1.4. [Optional] Property root > controlPlane > distro > advanced > paths > clientCACert
Type string
Required No
7.1.4.1.5. [Optional] Property root > controlPlane > distro > advanced > paths > requestHeaderCACert
Type string
Required No
7.2. [Optional] Property root > controlPlane > hostPathMapper
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/HostPathMapper
7.2.1. [Optional] Property root > controlPlane > hostPathMapper > enabled
Type boolean
Required No
7.2.2. [Optional] Property root > controlPlane > hostPathMapper > central
Type boolean
Required No
7.3. [Optional] Property root > controlPlane > coredns
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/CoreDNS
7.3.1. [Optional] Property root > controlPlane > coredns > enabled
Type boolean
Required No
7.3.2. [Optional] Property root > controlPlane > coredns > embedded
Type boolean
Required No
7.3.3. [Optional] Property root > controlPlane > coredns > service
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/CoreDNSService
7.3.3.1. [Optional] Property root > controlPlane > coredns > service > labels
Type object
Required No
Additional properties [Should-conform]
7.3.3.1.1. Property root > controlPlane > coredns > service > labels > additionalProperties
Type string
Required No
7.3.3.2. [Optional] Property root > controlPlane > coredns > service > annotations
Type object
Required No
Additional properties [Should-conform]
7.3.3.2.1. Property root > controlPlane > coredns > service > annotations > additionalProperties
Type string
Required No
7.3.3.3. [Optional] Property root > controlPlane > coredns > service > spec
Type object
Required No
Additional properties [Any type: allowed]
7.3.4. [Optional] Property root > controlPlane > coredns > deployment
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/CoreDNSDeployment
7.3.4.1. [Optional] Property root > controlPlane > coredns > deployment > labels
Type object
Required No
Additional properties [Should-conform]
7.3.4.1.1. Property root > controlPlane > coredns > deployment > labels > additionalProperties
Type string
Required No
7.3.4.2. [Optional] Property root > controlPlane > coredns > deployment > annotations
Type object
Required No
Additional properties [Should-conform]
7.3.4.2.1. Property root > controlPlane > coredns > deployment > annotations > additionalProperties
Type string
Required No
7.3.4.3. [Optional] Property root > controlPlane > coredns > deployment > spec
Type object
Required No
Additional properties [Any type: allowed]
7.4. [Optional] Property root > controlPlane > virtualScheduler
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
7.4.1. [Optional] Property root > controlPlane > virtualScheduler > enabled
Type boolean
Required No
7.5. [Optional] Property root > controlPlane > proxy
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneProxy
7.5.1. [Optional] Property root > controlPlane > proxy > bindAddress
Type string
Required No
7.5.2. [Optional] Property root > controlPlane > proxy > port
Type integer
Required No
7.5.3. [Optional] Property root > controlPlane > proxy > tls
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneProxyTLS
7.5.3.1. [Optional] Property root > controlPlane > proxy > tls > extraSANs
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
extraSANs items -
7.5.3.1.1. root > controlPlane > proxy > tls > extraSANs > extraSANs items
Type string
Required No
7.6. [Optional] Property root > controlPlane > service
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneService
7.6.1. [Optional] Property root > controlPlane > service > labels
Type object
Required No
Additional properties [Should-conform]
7.6.1.1. Property root > controlPlane > service > labels > additionalProperties
Type string
Required No
7.6.2. [Optional] Property root > controlPlane > service > annotations
Type object
Required No
Additional properties [Should-conform]
7.6.2.1. Property root > controlPlane > service > annotations > additionalProperties
Type string
Required No
7.6.3. [Optional] Property root > controlPlane > service > name
Type string
Required No
7.6.4. [Optional] Property root > controlPlane > service > spec
Type object
Required No
Additional properties [Any type: allowed]
7.7. [Optional] Property root > controlPlane > ingress
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneIngress
7.7.1. [Optional] Property root > controlPlane > ingress > enabled
Type boolean
Required No
7.7.2. [Optional] Property root > controlPlane > ingress > labels
Type object
Required No
Additional properties [Should-conform]
7.7.2.1. Property root > controlPlane > ingress > labels > additionalProperties
Type string
Required No
7.7.3. [Optional] Property root > controlPlane > ingress > annotations
Type object
Required No
Additional properties [Should-conform]
7.7.3.1. Property root > controlPlane > ingress > annotations > additionalProperties
Type string
Required No
7.7.4. [Optional] Property root > controlPlane > ingress > name
Type string
Required No
7.7.5. [Optional] Property root > controlPlane > ingress > spec
Type object
Required No
Additional properties [Any type: allowed]
7.8. [Optional] Property root > controlPlane > highAvailability
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneHighAvailability
7.8.1. [Optional] Property root > controlPlane > highAvailability > replicas
Type integer
Required No
7.9. [Optional] Property root > controlPlane > advanced
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneAdvanced
7.9.1. [Optional] Property root > controlPlane > advanced > defaultImageRegistry
Type string
Required No
7.9.2. [Optional] Property root > controlPlane > advanced > image
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ImageRef
7.9.2.1. [Optional] Property root > controlPlane > advanced > image > repository
Type string
Required No
7.9.2.2. [Optional] Property root > controlPlane > advanced > image > tag
Type string
Required No
7.9.3. [Optional] Property root > controlPlane > advanced > headless
Type boolean
Required No
7.9.4. [Optional] Property root > controlPlane > advanced > persistence
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlanePersistence
7.9.4.1. [Optional] Property root > controlPlane > advanced > persistence > enabled
Type boolean
Required No
7.9.4.2. [Optional] Property root > controlPlane > advanced > persistence > retentionPolicy
Type string
Required No
7.9.4.3. [Optional] Property root > controlPlane > advanced > persistence > size
Type string
Required No
7.9.4.4. [Optional] Property root > controlPlane > advanced > persistence > storageClass
Type string
Required No
7.9.4.5. [Optional] Property root > controlPlane > advanced > persistence > addVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.9.4.5.1. root > controlPlane > advanced > persistence > addVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.9.4.5.1.1. [Optional] Property root > controlPlane > advanced > persistence > addVolumeMounts > addVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.9.4.5.1.2. [Optional] Property root > controlPlane > advanced > persistence > addVolumeMounts > addVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.9.4.5.1.3. [Optional] Property root > controlPlane > advanced > persistence > addVolumeMounts > addVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.9.4.5.1.4. [Optional] Property root > controlPlane > advanced > persistence > addVolumeMounts > addVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.9.4.5.1.5. [Optional] Property root > controlPlane > advanced > persistence > addVolumeMounts > addVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.9.4.5.1.6. [Optional] Property root > controlPlane > advanced > persistence > addVolumeMounts > addVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.9.4.6. [Optional] Property root > controlPlane > advanced > persistence > overwriteVolumeMounts
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
VolumeMount VolumeMount describes a mounting of a Volume within a container.
7.9.4.6.1. root > controlPlane > advanced > persistence > overwriteVolumeMounts > VolumeMount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/VolumeMount

Description: VolumeMount describes a mounting of a Volume within a container.

7.9.4.6.1.1. [Optional] Property root > controlPlane > advanced > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > name
Type string
Required No

Description: This must match the Name of a Volume.

7.9.4.6.1.2. [Optional] Property root > controlPlane > advanced > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > readOnly
Type boolean
Required No

Description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

7.9.4.6.1.3. [Optional] Property root > controlPlane > advanced > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPath
Type string
Required No

Description: Path within the container at which the volume should be mounted. Must not contain ':'.

7.9.4.6.1.4. [Optional] Property root > controlPlane > advanced > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPath
Type string
Required No

Description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

7.9.4.6.1.5. [Optional] Property root > controlPlane > advanced > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > mountPropagation
Type string
Required No

Description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

7.9.4.6.1.6. [Optional] Property root > controlPlane > advanced > persistence > overwriteVolumeMounts > overwriteVolumeMounts items > subPathExpr
Type string
Required No

Description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

7.9.5. [Optional] Property root > controlPlane > advanced > scheduling
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneScheduling
7.9.5.1. [Optional] Property root > controlPlane > advanced > scheduling > nodeSelector
Type object
Required No
Additional properties [Any type: allowed]
7.9.5.2. [Optional] Property root > controlPlane > advanced > scheduling > affinity
Type object
Required No
Additional properties [Any type: allowed]
7.9.5.3. [Optional] Property root > controlPlane > advanced > scheduling > tolerations
Type object
Required No
Additional properties [Any type: allowed]
7.9.5.4. [Optional] Property root > controlPlane > advanced > scheduling > priorityClassName
Type string
Required No
7.9.6. [Optional] Property root > controlPlane > advanced > serviceAccounts
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneServiceAccounts
7.9.6.1. [Optional] Property root > controlPlane > advanced > serviceAccounts > enabled
Type boolean
Required No
7.9.6.2. [Optional] Property root > controlPlane > advanced > serviceAccounts > name
Type string
Required No
7.9.6.3. [Optional] Property root > controlPlane > advanced > serviceAccounts > imagePullSecrets
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
LocalObjectReference LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
7.9.6.3.1. root > controlPlane > advanced > serviceAccounts > imagePullSecrets > LocalObjectReference
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LocalObjectReference

Description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

7.9.6.3.1.1. [Optional] Property root > controlPlane > advanced > serviceAccounts > imagePullSecrets > imagePullSecrets items > name
Type string
Required No

Description: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

7.9.7. [Optional] Property root > controlPlane > advanced > workloadServiceAccount
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneWorkloadServiceAccount
7.9.7.1. [Optional] Property root > controlPlane > advanced > workloadServiceAccount > enabled
Type boolean
Required No
7.9.7.2. [Optional] Property root > controlPlane > advanced > workloadServiceAccount > name
Type string
Required No
7.9.7.3. [Optional] Property root > controlPlane > advanced > workloadServiceAccount > annotations
Type object
Required No
Additional properties [Should-conform]
7.9.7.3.1. Property root > controlPlane > advanced > workloadServiceAccount > annotations > additionalProperties
Type string
Required No
7.9.8. [Optional] Property root > controlPlane > advanced > probes
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneProbes
7.9.8.1. [Optional] Property root > controlPlane > advanced > probes > livenessProbe
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
7.9.8.1.1. [Optional] Property root > controlPlane > advanced > probes > livenessProbe > enabled
Type boolean
Required No
7.9.8.2. [Optional] Property root > controlPlane > advanced > probes > readinessProbe
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/EnableSwitch
7.9.8.2.1. [Optional] Property root > controlPlane > advanced > probes > readinessProbe > enabled
Type boolean
Required No
7.9.9. [Optional] Property root > controlPlane > advanced > security
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneSecurity
7.9.9.1. [Optional] Property root > controlPlane > advanced > security > podSecurityContext
Type object
Required No
Additional properties [Any type: allowed]
7.9.9.2. [Optional] Property root > controlPlane > advanced > security > containerSecurityContext
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneContainerSecurityContext
7.9.9.2.1. [Optional] Property root > controlPlane > advanced > security > containerSecurityContext > allowPrivilegeEscalation
Type boolean
Required No
7.9.9.2.2. [Optional] Property root > controlPlane > advanced > security > containerSecurityContext > capabilities
Type object
Required No
Additional properties [Any type: allowed]
7.9.9.2.3. [Optional] Property root > controlPlane > advanced > security > containerSecurityContext > runAsUser
Type integer
Required No
7.9.9.2.4. [Optional] Property root > controlPlane > advanced > security > containerSecurityContext > runAsGroup
Type integer
Required No
7.9.10. [Optional] Property root > controlPlane > advanced > metadata
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ControlPlaneMetadata
7.9.10.1. [Optional] Property root > controlPlane > advanced > metadata > statefulSet
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LabelsAndAnnotations
7.9.10.1.1. [Optional] Property root > controlPlane > advanced > metadata > statefulSet > labels
Type object
Required No
Additional properties [Should-conform]
7.9.10.1.1.1. Property root > controlPlane > advanced > metadata > statefulSet > labels > additionalProperties
Type string
Required No
7.9.10.1.2. [Optional] Property root > controlPlane > advanced > metadata > statefulSet > annotations
Type object
Required No
Additional properties [Should-conform]
7.9.10.1.2.1. Property root > controlPlane > advanced > metadata > statefulSet > annotations > additionalProperties
Type string
Required No
7.9.10.2. [Optional] Property root > controlPlane > advanced > metadata > pods
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LabelsAndAnnotations
7.9.10.2.1. [Optional] Property root > controlPlane > advanced > metadata > pods > labels
Type object
Required No
Additional properties [Should-conform]
7.9.10.2.1.1. Property root > controlPlane > advanced > metadata > pods > labels > additionalProperties
Type string
Required No
7.9.10.2.2. [Optional] Property root > controlPlane > advanced > metadata > pods > annotations
Type object
Required No
Additional properties [Should-conform]
7.9.10.2.2.1. Property root > controlPlane > advanced > metadata > pods > annotations > additionalProperties
Type string
Required No
7.9.10.3. [Optional] Property root > controlPlane > advanced > metadata > allResources
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LabelsAndAnnotations
7.9.10.3.1. [Optional] Property root > controlPlane > advanced > metadata > allResources > labels
Type object
Required No
Additional properties [Should-conform]
7.9.10.3.1.1. Property root > controlPlane > advanced > metadata > allResources > labels > additionalProperties
Type string
Required No
7.9.10.3.2. [Optional] Property root > controlPlane > advanced > metadata > allResources > annotations
Type object
Required No
Additional properties [Should-conform]
7.9.10.3.2.1. Property root > controlPlane > advanced > metadata > allResources > annotations > additionalProperties
Type string
Required No
8. [Optional] Property root > policies
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Policies
8.1. [Optional] Property root > policies > podSecurityStandard
Type string
Required No
8.2. [Optional] Property root > policies > resourceQuota
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ResourceQuota
8.2.1. [Optional] Property root > policies > resourceQuota > enabled
Type boolean
Required No
8.2.2. [Optional] Property root > policies > resourceQuota > quota
Type object
Required No
Additional properties [Should-conform]
8.2.2.1. Property root > policies > resourceQuota > quota > additionalProperties
Type string
Required No
8.2.3. [Optional] Property root > policies > resourceQuota > scopeSelector
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ScopeSelector
8.2.3.1. [Optional] Property root > policies > resourceQuota > scopeSelector > matchExpressions
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
LabelSelectorRequirement -
8.2.3.1.1. root > policies > resourceQuota > scopeSelector > matchExpressions > LabelSelectorRequirement
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LabelSelectorRequirement
8.2.3.1.1.1. [Optional] Property root > policies > resourceQuota > scopeSelector > matchExpressions > matchExpressions items > key
Type string
Required No

Description: key is the label key that the selector applies to.

8.2.3.1.1.2. [Optional] Property root > policies > resourceQuota > scopeSelector > matchExpressions > matchExpressions items > operator
Type string
Required No

Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

8.2.3.1.1.3. [Optional] Property root > policies > resourceQuota > scopeSelector > matchExpressions > matchExpressions items > values
Type array of string
Required No

Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
values items -
8.2.3.1.1.3.1. root > policies > resourceQuota > scopeSelector > matchExpressions > matchExpressions items > values > values items
Type string
Required No
8.2.4. [Optional] Property root > policies > resourceQuota > scopes
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
scopes items -
8.2.4.1. root > policies > resourceQuota > scopes > scopes items
Type string
Required No
8.3. [Optional] Property root > policies > limitRange
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LimitRange
8.3.1. [Optional] Property root > policies > limitRange > enabled
Type boolean
Required No
8.3.2. [Optional] Property root > policies > limitRange > default
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LimitRangeLimits
8.3.2.1. [Optional] Property root > policies > limitRange > default > ephemeral-storage
Type string
Required No
8.3.2.2. [Optional] Property root > policies > limitRange > default > memory
Type string
Required No
8.3.2.3. [Optional] Property root > policies > limitRange > default > cpu
Type string
Required No
8.3.3. [Optional] Property root > policies > limitRange > defaultRequest
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/LimitRangeLimits
8.3.3.1. [Optional] Property root > policies > limitRange > defaultRequest > ephemeral-storage
Type string
Required No
8.3.3.2. [Optional] Property root > policies > limitRange > defaultRequest > memory
Type string
Required No
8.3.3.3. [Optional] Property root > policies > limitRange > defaultRequest > cpu
Type string
Required No
8.4. [Optional] Property root > policies > networkPolicy
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/NetworkPolicy
8.4.1. [Optional] Property root > policies > networkPolicy > enabled
Type boolean
Required No
8.4.2. [Optional] Property root > policies > networkPolicy > outgoingConnections
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/OutgoingConnections
8.4.2.1. [Optional] Property root > policies > networkPolicy > outgoingConnections > ipBlock
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/IPBlock

Description: IPBlock describes a particular CIDR (Ex.

8.4.2.1.1. [Optional] Property root > policies > networkPolicy > outgoingConnections > ipBlock > cidr
Type string
Required No

Description: cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"

8.4.2.1.2. [Optional] Property root > policies > networkPolicy > outgoingConnections > ipBlock > except
Type array of string
Required No

Description: except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range +optional

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
except items -
8.4.2.1.2.1. root > policies > networkPolicy > outgoingConnections > ipBlock > except > except items
Type string
Required No
8.5. [Optional] Property root > policies > admissionControl
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/AdmissionControl
8.5.1. [Optional] Property root > policies > admissionControl > validatingWebhooks
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items True
Tuple validation N/A
8.5.2. [Optional] Property root > policies > admissionControl > mutatingWebhooks
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items True
Tuple validation N/A
9. [Optional] Property root > rbac
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/RBAC
9.1. [Optional] Property root > rbac > clusterRole
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/RBACClusterRole
9.1.1. [Optional] Property root > rbac > clusterRole > create
Type boolean
Required No
9.1.2. [Optional] Property root > rbac > clusterRole > extraRules
Type object
Required No
Additional properties [Any type: allowed]
9.2. [Optional] Property root > rbac > role
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/RBACRole
9.2.1. [Optional] Property root > rbac > role > create
Type boolean
Required No
9.2.2. [Optional] Property root > rbac > role > extraRules
Type object
Required No
Additional properties [Any type: allowed]
9.2.3. [Optional] Property root > rbac > role > excludedApiResources
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
excludedApiResources items -
9.2.3.1. root > rbac > role > excludedApiResources > excludedApiResources items
Type string
Required No
10. [Optional] Property root > telemetry
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Telemetry

Description: Telemetry is the configuration related to telemetry gathered about vcluster usage.

10.1. [Optional] Property root > telemetry > disabled
Type boolean
Required No
10.2. [Optional] Property root > telemetry > instanceCreators
Type string
Required No
10.3. [Optional] Property root > telemetry > platformUserID
Type string
Required No
10.4. [Optional] Property root > telemetry > platformInstanceID
Type string
Required No
10.5. [Optional] Property root > telemetry > machineID
Type string
Required No
11. [Optional] Property root > experimental
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Experimental
11.1. [Optional] Property root > experimental > Extended
Type object
Required No
Additional properties [Any type: allowed]
11.2. [Optional] Property root > experimental > controlPlaneSettings
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExperimentalControlPlaneSettings
11.2.1. [Optional] Property root > experimental > controlPlaneSettings > rewriteKubernetesService
Type boolean
Required No
11.3. [Optional] Property root > experimental > syncSettings
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExperimentalSyncSettings
11.3.1. [Optional] Property root > experimental > syncSettings > disableSync
Type boolean
Required No
11.3.2. [Optional] Property root > experimental > syncSettings > target
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExperimentalSyncSettingsTarget
11.3.2.1. [Optional] Property root > experimental > syncSettings > target > namespace
Type string
Required No
11.4. [Optional] Property root > experimental > syncPatches
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncPatches
11.4.1. [Optional] Property root > experimental > syncPatches > version
Type string
Required No

Description: Version is the config version

11.4.2. [Optional] Property root > experimental > syncPatches > export
Type array
Required No

Description: Exports syncs a resource from the virtual cluster to the host

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Export -
11.4.2.1. root > experimental > syncPatches > export > Export
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Export
11.4.2.1.1. [Optional] Property root > experimental > syncPatches > export > export items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.4.2.1.2. [Optional] Property root > experimental > syncPatches > export > export items > kind
Type string
Required No

Description: Kind of the object to sync

11.4.2.1.3. [Optional] Property root > experimental > syncPatches > export > export items > optional
Type boolean
Required No
11.4.2.1.4. [Optional] Property root > experimental > syncPatches > export > export items > replaceOnConflict
Type boolean
Required No

Description: ReplaceWhenInvalid determines if the controller should try to recreate the object if there is a problem applying

11.4.2.1.5. [Optional] Property root > experimental > syncPatches > export > export items > patches
Type array
Required No

Description: Patches are the patches to apply on the virtual cluster objects when syncing them from the host cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.4.2.1.5.1. root > experimental > syncPatches > export > export items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.4.2.1.5.1.1. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.4.2.1.5.1.2. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.4.2.1.5.1.3. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.4.2.1.5.1.4. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.4.2.1.5.1.5. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.4.2.1.5.1.6. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.4.2.1.5.1.7. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.4.2.1.5.1.8. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.4.2.1.5.1.8.1. root > experimental > syncPatches > export > export items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.4.2.1.5.1.8.1.1. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.4.2.1.5.1.8.1.2. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.4.2.1.5.1.8.1.3. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.4.2.1.5.1.8.1.4. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.4.2.1.5.1.8.1.5. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.4.2.1.5.1.9. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.4.2.1.5.1.10. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.4.2.1.5.1.10.1. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > sync > secret
Type boolean
Required No
11.4.2.1.5.1.10.2. [Optional] Property root > experimental > syncPatches > export > export items > patches > patches items > sync > configmap
Type boolean
Required No
11.4.2.1.6. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches
Type array
Required No

Description: ReversePatches are the patches to apply to host cluster objects after it has been synced to the virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.4.2.1.6.1. root > experimental > syncPatches > export > export items > reversePatches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.4.2.1.6.1.1. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > op
Type string
Required No

Description: Operation is the type of the patch

11.4.2.1.6.1.2. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.4.2.1.6.1.3. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > path
Type string
Required No

Description: Path is the path of the patch

11.4.2.1.6.1.4. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.4.2.1.6.1.5. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.4.2.1.6.1.6. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.4.2.1.6.1.7. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.4.2.1.6.1.8. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.4.2.1.6.1.8.1. root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.4.2.1.6.1.8.1.1. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.4.2.1.6.1.8.1.2. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.4.2.1.6.1.8.1.3. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.4.2.1.6.1.8.1.4. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.4.2.1.6.1.8.1.5. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.4.2.1.6.1.9. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.4.2.1.6.1.10. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.4.2.1.6.1.10.1. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > sync > secret
Type boolean
Required No
11.4.2.1.6.1.10.2. [Optional] Property root > experimental > syncPatches > export > export items > reversePatches > reversePatches items > sync > configmap
Type boolean
Required No
11.4.2.1.7. [Optional] Property root > experimental > syncPatches > export > export items > selector
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Selector

Description: Selector is a label selector to select the synced objects in the virtual cluster. If empty, all objects will be synced.

11.4.2.1.7.1. [Optional] Property root > experimental > syncPatches > export > export items > selector > labelSelector
Type object
Required No
Additional properties [Should-conform]

Description: LabelSelector are the labels to select the object from

11.4.2.1.7.1.1. Property root > experimental > syncPatches > export > export items > selector > labelSelector > additionalProperties
Type string
Required No
11.4.3. [Optional] Property root > experimental > syncPatches > import
Type array
Required No

Description: Imports syncs a resource from the host cluster to virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Import -
11.4.3.1. root > experimental > syncPatches > import > Import
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Import
11.4.3.1.1. [Optional] Property root > experimental > syncPatches > import > import items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.4.3.1.2. [Optional] Property root > experimental > syncPatches > import > import items > kind
Type string
Required No

Description: Kind of the object to sync

11.4.3.1.3. [Optional] Property root > experimental > syncPatches > import > import items > optional
Type boolean
Required No
11.4.3.1.4. [Optional] Property root > experimental > syncPatches > import > import items > replaceOnConflict
Type boolean
Required No

Description: ReplaceWhenInvalid determines if the controller should try to recreate the object if there is a problem applying

11.4.3.1.5. [Optional] Property root > experimental > syncPatches > import > import items > patches
Type array
Required No

Description: Patches are the patches to apply on the virtual cluster objects when syncing them from the host cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.4.3.1.5.1. root > experimental > syncPatches > import > import items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.4.3.1.5.1.1. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.4.3.1.5.1.2. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.4.3.1.5.1.3. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.4.3.1.5.1.4. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.4.3.1.5.1.5. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.4.3.1.5.1.6. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.4.3.1.5.1.7. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.4.3.1.5.1.8. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.4.3.1.5.1.8.1. root > experimental > syncPatches > import > import items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.4.3.1.5.1.8.1.1. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.4.3.1.5.1.8.1.2. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.4.3.1.5.1.8.1.3. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.4.3.1.5.1.8.1.4. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.4.3.1.5.1.8.1.5. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.4.3.1.5.1.9. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.4.3.1.5.1.10. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.4.3.1.5.1.10.1. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > sync > secret
Type boolean
Required No
11.4.3.1.5.1.10.2. [Optional] Property root > experimental > syncPatches > import > import items > patches > patches items > sync > configmap
Type boolean
Required No
11.4.3.1.6. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches
Type array
Required No

Description: ReversePatches are the patches to apply to host cluster objects after it has been synced to the virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.4.3.1.6.1. root > experimental > syncPatches > import > import items > reversePatches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.4.3.1.6.1.1. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > op
Type string
Required No

Description: Operation is the type of the patch

11.4.3.1.6.1.2. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.4.3.1.6.1.3. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > path
Type string
Required No

Description: Path is the path of the patch

11.4.3.1.6.1.4. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.4.3.1.6.1.5. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.4.3.1.6.1.6. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.4.3.1.6.1.7. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.4.3.1.6.1.8. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.4.3.1.6.1.8.1. root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.4.3.1.6.1.8.1.1. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.4.3.1.6.1.8.1.2. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.4.3.1.6.1.8.1.3. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.4.3.1.6.1.8.1.4. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.4.3.1.6.1.8.1.5. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.4.3.1.6.1.9. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.4.3.1.6.1.10. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.4.3.1.6.1.10.1. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > sync > secret
Type boolean
Required No
11.4.3.1.6.1.10.2. [Optional] Property root > experimental > syncPatches > import > import items > reversePatches > reversePatches items > sync > configmap
Type boolean
Required No
11.4.4. [Optional] Property root > experimental > syncPatches > hooks
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Hooks

Description: Hooks are hooks that can be used to inject custom patches before syncing

11.4.4.1. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual
Type array
Required No

Description: HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Hook -
11.4.4.1.1. root > experimental > syncPatches > hooks > hostToVirtual > Hook
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Hook
11.4.4.1.1.1. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.4.4.1.1.2. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > kind
Type string
Required No

Description: Kind of the object to sync

11.4.4.1.1.3. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > verbs
Type array of string
Required No

Description: Verbs are the verbs that the hook should mutate

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
11.4.4.1.1.3.1. root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > verbs > verbs items
Type string
Required No
11.4.4.1.1.4. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches
Type array
Required No

Description: Patches are the patches to apply on the object to be synced

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.4.4.1.1.4.1. root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.4.4.1.1.4.1.1. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.4.4.1.1.4.1.2. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.4.4.1.1.4.1.3. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.4.4.1.1.4.1.4. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.4.4.1.1.4.1.5. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.4.4.1.1.4.1.6. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.4.4.1.1.4.1.7. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.4.4.1.1.4.1.8. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.4.4.1.1.4.1.8.1. root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.4.4.1.1.4.1.8.1.1. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.4.4.1.1.4.1.8.1.2. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.4.4.1.1.4.1.8.1.3. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.4.4.1.1.4.1.8.1.4. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.4.4.1.1.4.1.8.1.5. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.4.4.1.1.4.1.9. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.4.4.1.1.4.1.10. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.4.4.1.1.4.1.10.1. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > sync > secret
Type boolean
Required No
11.4.4.1.1.4.1.10.2. [Optional] Property root > experimental > syncPatches > hooks > hostToVirtual > hostToVirtual items > patches > patches items > sync > configmap
Type boolean
Required No
11.4.4.2. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost
Type array
Required No

Description: VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Hook -
11.4.4.2.1. root > experimental > syncPatches > hooks > virtualToHost > Hook
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Hook
11.4.4.2.1.1. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.4.4.2.1.2. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > kind
Type string
Required No

Description: Kind of the object to sync

11.4.4.2.1.3. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > verbs
Type array of string
Required No

Description: Verbs are the verbs that the hook should mutate

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
11.4.4.2.1.3.1. root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > verbs > verbs items
Type string
Required No
11.4.4.2.1.4. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches
Type array
Required No

Description: Patches are the patches to apply on the object to be synced

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.4.4.2.1.4.1. root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.4.4.2.1.4.1.1. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.4.4.2.1.4.1.2. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.4.4.2.1.4.1.3. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.4.4.2.1.4.1.4. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.4.4.2.1.4.1.5. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.4.4.2.1.4.1.6. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.4.4.2.1.4.1.7. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.4.4.2.1.4.1.8. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.4.4.2.1.4.1.8.1. root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.4.4.2.1.4.1.8.1.1. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.4.4.2.1.4.1.8.1.2. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.4.4.2.1.4.1.8.1.3. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.4.4.2.1.4.1.8.1.4. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.4.4.2.1.4.1.8.1.5. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.4.4.2.1.4.1.9. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.4.4.2.1.4.1.10. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.4.4.2.1.4.1.10.1. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > sync > secret
Type boolean
Required No
11.4.4.2.1.4.1.10.2. [Optional] Property root > experimental > syncPatches > hooks > virtualToHost > virtualToHost items > patches > patches items > sync > configmap
Type boolean
Required No
11.5. [Optional] Property root > experimental > genericSync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SyncPatches
11.5.1. [Optional] Property root > experimental > genericSync > version
Type string
Required No

Description: Version is the config version

11.5.2. [Optional] Property root > experimental > genericSync > export
Type array
Required No

Description: Exports syncs a resource from the virtual cluster to the host

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Export -
11.5.2.1. root > experimental > genericSync > export > Export
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Export
11.5.2.1.1. [Optional] Property root > experimental > genericSync > export > export items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.5.2.1.2. [Optional] Property root > experimental > genericSync > export > export items > kind
Type string
Required No

Description: Kind of the object to sync

11.5.2.1.3. [Optional] Property root > experimental > genericSync > export > export items > optional
Type boolean
Required No
11.5.2.1.4. [Optional] Property root > experimental > genericSync > export > export items > replaceOnConflict
Type boolean
Required No

Description: ReplaceWhenInvalid determines if the controller should try to recreate the object if there is a problem applying

11.5.2.1.5. [Optional] Property root > experimental > genericSync > export > export items > patches
Type array
Required No

Description: Patches are the patches to apply on the virtual cluster objects when syncing them from the host cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.5.2.1.5.1. root > experimental > genericSync > export > export items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.5.2.1.5.1.1. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.5.2.1.5.1.2. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.5.2.1.5.1.3. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.5.2.1.5.1.4. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.5.2.1.5.1.5. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.5.2.1.5.1.6. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.5.2.1.5.1.7. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.5.2.1.5.1.8. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.5.2.1.5.1.8.1. root > experimental > genericSync > export > export items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.5.2.1.5.1.8.1.1. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.5.2.1.5.1.8.1.2. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.5.2.1.5.1.8.1.3. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.5.2.1.5.1.8.1.4. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.5.2.1.5.1.8.1.5. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.5.2.1.5.1.9. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.5.2.1.5.1.10. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.5.2.1.5.1.10.1. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > sync > secret
Type boolean
Required No
11.5.2.1.5.1.10.2. [Optional] Property root > experimental > genericSync > export > export items > patches > patches items > sync > configmap
Type boolean
Required No
11.5.2.1.6. [Optional] Property root > experimental > genericSync > export > export items > reversePatches
Type array
Required No

Description: ReversePatches are the patches to apply to host cluster objects after it has been synced to the virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.5.2.1.6.1. root > experimental > genericSync > export > export items > reversePatches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.5.2.1.6.1.1. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > op
Type string
Required No

Description: Operation is the type of the patch

11.5.2.1.6.1.2. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.5.2.1.6.1.3. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > path
Type string
Required No

Description: Path is the path of the patch

11.5.2.1.6.1.4. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.5.2.1.6.1.5. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.5.2.1.6.1.6. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.5.2.1.6.1.7. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.5.2.1.6.1.8. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.5.2.1.6.1.8.1. root > experimental > genericSync > export > export items > reversePatches > reversePatches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.5.2.1.6.1.8.1.1. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.5.2.1.6.1.8.1.2. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.5.2.1.6.1.8.1.3. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.5.2.1.6.1.8.1.4. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.5.2.1.6.1.8.1.5. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.5.2.1.6.1.9. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.5.2.1.6.1.10. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.5.2.1.6.1.10.1. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > sync > secret
Type boolean
Required No
11.5.2.1.6.1.10.2. [Optional] Property root > experimental > genericSync > export > export items > reversePatches > reversePatches items > sync > configmap
Type boolean
Required No
11.5.2.1.7. [Optional] Property root > experimental > genericSync > export > export items > selector
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Selector

Description: Selector is a label selector to select the synced objects in the virtual cluster. If empty, all objects will be synced.

11.5.2.1.7.1. [Optional] Property root > experimental > genericSync > export > export items > selector > labelSelector
Type object
Required No
Additional properties [Should-conform]

Description: LabelSelector are the labels to select the object from

11.5.2.1.7.1.1. Property root > experimental > genericSync > export > export items > selector > labelSelector > additionalProperties
Type string
Required No
11.5.3. [Optional] Property root > experimental > genericSync > import
Type array
Required No

Description: Imports syncs a resource from the host cluster to virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Import -
11.5.3.1. root > experimental > genericSync > import > Import
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Import
11.5.3.1.1. [Optional] Property root > experimental > genericSync > import > import items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.5.3.1.2. [Optional] Property root > experimental > genericSync > import > import items > kind
Type string
Required No

Description: Kind of the object to sync

11.5.3.1.3. [Optional] Property root > experimental > genericSync > import > import items > optional
Type boolean
Required No
11.5.3.1.4. [Optional] Property root > experimental > genericSync > import > import items > replaceOnConflict
Type boolean
Required No

Description: ReplaceWhenInvalid determines if the controller should try to recreate the object if there is a problem applying

11.5.3.1.5. [Optional] Property root > experimental > genericSync > import > import items > patches
Type array
Required No

Description: Patches are the patches to apply on the virtual cluster objects when syncing them from the host cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.5.3.1.5.1. root > experimental > genericSync > import > import items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.5.3.1.5.1.1. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.5.3.1.5.1.2. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.5.3.1.5.1.3. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.5.3.1.5.1.4. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.5.3.1.5.1.5. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.5.3.1.5.1.6. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.5.3.1.5.1.7. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.5.3.1.5.1.8. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.5.3.1.5.1.8.1. root > experimental > genericSync > import > import items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.5.3.1.5.1.8.1.1. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.5.3.1.5.1.8.1.2. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.5.3.1.5.1.8.1.3. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.5.3.1.5.1.8.1.4. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.5.3.1.5.1.8.1.5. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.5.3.1.5.1.9. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.5.3.1.5.1.10. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.5.3.1.5.1.10.1. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > sync > secret
Type boolean
Required No
11.5.3.1.5.1.10.2. [Optional] Property root > experimental > genericSync > import > import items > patches > patches items > sync > configmap
Type boolean
Required No
11.5.3.1.6. [Optional] Property root > experimental > genericSync > import > import items > reversePatches
Type array
Required No

Description: ReversePatches are the patches to apply to host cluster objects after it has been synced to the virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.5.3.1.6.1. root > experimental > genericSync > import > import items > reversePatches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.5.3.1.6.1.1. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > op
Type string
Required No

Description: Operation is the type of the patch

11.5.3.1.6.1.2. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.5.3.1.6.1.3. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > path
Type string
Required No

Description: Path is the path of the patch

11.5.3.1.6.1.4. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.5.3.1.6.1.5. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.5.3.1.6.1.6. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.5.3.1.6.1.7. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.5.3.1.6.1.8. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.5.3.1.6.1.8.1. root > experimental > genericSync > import > import items > reversePatches > reversePatches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.5.3.1.6.1.8.1.1. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.5.3.1.6.1.8.1.2. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.5.3.1.6.1.8.1.3. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.5.3.1.6.1.8.1.4. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.5.3.1.6.1.8.1.5. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.5.3.1.6.1.9. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.5.3.1.6.1.10. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.5.3.1.6.1.10.1. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > sync > secret
Type boolean
Required No
11.5.3.1.6.1.10.2. [Optional] Property root > experimental > genericSync > import > import items > reversePatches > reversePatches items > sync > configmap
Type boolean
Required No
11.5.4. [Optional] Property root > experimental > genericSync > hooks
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Hooks

Description: Hooks are hooks that can be used to inject custom patches before syncing

11.5.4.1. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual
Type array
Required No

Description: HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Hook -
11.5.4.1.1. root > experimental > genericSync > hooks > hostToVirtual > Hook
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Hook
11.5.4.1.1.1. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.5.4.1.1.2. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > kind
Type string
Required No

Description: Kind of the object to sync

11.5.4.1.1.3. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > verbs
Type array of string
Required No

Description: Verbs are the verbs that the hook should mutate

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
11.5.4.1.1.3.1. root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > verbs > verbs items
Type string
Required No
11.5.4.1.1.4. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches
Type array
Required No

Description: Patches are the patches to apply on the object to be synced

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.5.4.1.1.4.1. root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.5.4.1.1.4.1.1. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.5.4.1.1.4.1.2. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.5.4.1.1.4.1.3. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.5.4.1.1.4.1.4. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.5.4.1.1.4.1.5. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.5.4.1.1.4.1.6. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.5.4.1.1.4.1.7. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.5.4.1.1.4.1.8. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.5.4.1.1.4.1.8.1. root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.5.4.1.1.4.1.8.1.1. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.5.4.1.1.4.1.8.1.2. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.5.4.1.1.4.1.8.1.3. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.5.4.1.1.4.1.8.1.4. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.5.4.1.1.4.1.8.1.5. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.5.4.1.1.4.1.9. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.5.4.1.1.4.1.10. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.5.4.1.1.4.1.10.1. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > sync > secret
Type boolean
Required No
11.5.4.1.1.4.1.10.2. [Optional] Property root > experimental > genericSync > hooks > hostToVirtual > hostToVirtual items > patches > patches items > sync > configmap
Type boolean
Required No
11.5.4.2. [Optional] Property root > experimental > genericSync > hooks > virtualToHost
Type array
Required No

Description: VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Hook -
11.5.4.2.1. root > experimental > genericSync > hooks > virtualToHost > Hook
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Hook
11.5.4.2.1.1. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > apiVersion
Type string
Required No

Description: APIVersion of the object to sync

11.5.4.2.1.2. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > kind
Type string
Required No

Description: Kind of the object to sync

11.5.4.2.1.3. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > verbs
Type array of string
Required No

Description: Verbs are the verbs that the hook should mutate

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
verbs items -
11.5.4.2.1.3.1. root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > verbs > verbs items
Type string
Required No
11.5.4.2.1.4. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches
Type array
Required No

Description: Patches are the patches to apply on the object to be synced

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Patch -
11.5.4.2.1.4.1. root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > Patch
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Patch
11.5.4.2.1.4.1.1. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > op
Type string
Required No

Description: Operation is the type of the patch

11.5.4.2.1.4.1.2. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > fromPath
Type string
Required No

Description: FromPath is the path from the other object

11.5.4.2.1.4.1.3. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > path
Type string
Required No

Description: Path is the path of the patch

11.5.4.2.1.4.1.4. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > namePath
Type string
Required No

Description: NamePath is the path to the name of a child resource within Path

11.5.4.2.1.4.1.5. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > namespacePath
Type string
Required No

Description: NamespacePath is path to the namespace of a child resource within Path

11.5.4.2.1.4.1.6. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > value
Type object
Required No
Additional properties [Any type: allowed]

Description: Value is the new value to be set to the path

11.5.4.2.1.4.1.7. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > regex
Type string
Required No

Description: Regex - is regular expresion used to identify the Name, and optionally Namespace, parts of the field value that will be replaced with the rewritten Name and/or Namespace

11.5.4.2.1.4.1.8. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions
Type array
Required No

Description: Conditions are conditions that must be true for the patch to get executed

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
PatchCondition -
11.5.4.2.1.4.1.8.1. root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > PatchCondition
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchCondition
11.5.4.2.1.4.1.8.1.1. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > path
Type string
Required No

Description: Path is the path within the object to select

11.5.4.2.1.4.1.8.1.2. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > subPath
Type string
Required No

Description: SubPath is the path below the selected object to select

11.5.4.2.1.4.1.8.1.3. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > equal
Type object
Required No
Additional properties [Any type: allowed]

Description: Equal is the value the path should be equal to

11.5.4.2.1.4.1.8.1.4. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > notEqual
Type object
Required No
Additional properties [Any type: allowed]

Description: NotEqual is the value the path should not be equal to

11.5.4.2.1.4.1.8.1.5. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > conditions > conditions items > empty
Type boolean
Required No

Description: Empty means that the path value should be empty or unset

11.5.4.2.1.4.1.9. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > ignore
Type boolean
Required No

Description: Ignore determines if the path should be ignored if handled as a reverse patch

11.5.4.2.1.4.1.10. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > sync
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/PatchSync

Description: Sync defines if a specialized syncer should be initialized using values from the rewriteName operation as Secret/Configmap names to be synced

11.5.4.2.1.4.1.10.1. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > sync > secret
Type boolean
Required No
11.5.4.2.1.4.1.10.2. [Optional] Property root > experimental > genericSync > hooks > virtualToHost > virtualToHost items > patches > patches items > sync > configmap
Type boolean
Required No
11.6. [Optional] Property root > experimental > deploy
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/ExperimentalDeploy
11.6.1. [Optional] Property root > experimental > deploy > manifests
Type string
Required No
11.6.2. [Optional] Property root > experimental > deploy > manifestsTemplate
Type string
Required No
11.6.3. [Optional] Property root > experimental > deploy > helm
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items True
Tuple validation N/A
12. [Optional] Property root > license
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SecretKeyReference
12.1. [Optional] Property root > license > key
Type string
Required No
12.2. [Optional] Property root > license > keySecretRef
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SecretReference

Description: SecretReference represents a Secret Reference.

12.2.1. [Optional] Property root > license > keySecretRef > name
Type string
Required No

Description: name is unique within a namespace to reference a secret resource.

12.2.2. [Optional] Property root > license > keySecretRef > namespace
Type string
Required No

Description: namespace defines the space within which the secret name must be unique.

13. [Optional] Property root > platform
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/Platform
13.1. [Optional] Property root > platform > name
Type string
Required No
13.2. [Optional] Property root > platform > owner
Type string
Required No
13.3. [Optional] Property root > platform > project
Type string
Required No
13.4. [Optional] Property root > platform > apiKey
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SecretKeyReference
13.4.1. [Optional] Property root > platform > apiKey > key
Type string
Required No
13.4.2. [Optional] Property root > platform > apiKey > keySecretRef
Type object
Required No
Additional properties [Not allowed]
Defined in #/$defs/SecretReference

Description: SecretReference represents a Secret Reference.

13.4.2.1. [Optional] Property root > platform > apiKey > keySecretRef > name
Type string
Required No

Description: name is unique within a namespace to reference a secret resource.

13.4.2.2. [Optional] Property root > platform > apiKey > keySecretRef > namespace
Type string
Required No

Description: namespace defines the space within which the secret name must be unique.


Generated using json-schema-for-humans on 2024-03-07 at 16:24:11 +0100

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment