EKSCluster - EKS Cluster Schema
This document explains the full schema for the kind: EKSCluster for the furyctl.yaml file used by furyctl. This configuration file will be used to deploy a Kubernetes Fury Cluster deployed through AWS's Elastic Kubernetes Service.
An example file can be found here.
Properties
| Property | Type | Required |
|---|---|---|
| apiVersion | string | Required |
| kind | string | Required |
| metadata | object | Required |
| spec | object | Required |
.apiVersion
Constraints
pattern: the string must match the following regular expression:
^kfd\.sighup\.io/v\d+((alpha|beta)\d+)?$
.kind
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"EKSCluster" |
.metadata
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
.metadata.name
maximum length: the maximum number of characters for this string is: 19
minimum length: the minimum number of characters for this string is: 1
.spec
Properties
| Property | Type | Required |
|---|---|---|
| distributionVersion | string | Required |
| region | string | Required |
| tags | object | Optional |
| toolsConfiguration | object | Required |
| infrastructure | object | Optional* |
| kubernetes | object | Required |
| distribution | object | Required |
*infrastructure: if omitted, you need to provide vpcId and subnetIds in .spec.kubernetes*
.spec.distributionVersion
Constraints
minimum length: the minimum number of characters for this string is: 1
.spec.region
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"af-south-1" |
"ap-east-1" |
"ap-northeast-1" |
"ap-northeast-2" |
"ap-northeast-3" |
"ap-south-1" |
"ap-south-2" |
"ap-southeast-1" |
"ap-southeast-2" |
"ap-southeast-3" |
"ap-southeast-4" |
"ca-central-1" |
"eu-central-1" |
"eu-central-2" |
"eu-north-1" |
"eu-south-1" |
"eu-south-2" |
"eu-west-1" |
"eu-west-2" |
"eu-west-3" |
"me-central-1" |
"me-south-1" |
"sa-east-1" |
"us-east-1" |
"us-east-2" |
"us-gov-east-1" |
"us-gov-west-1" |
"us-west-1" |
"us-west-2" |
.spec.tags
Description
This map defines which will be the common tags that will be added to all the resources created on AWS.
.spec.toolsConfiguration
Properties
| Property | Type | Required |
|---|---|---|
| terraform | object | Required |
.spec.toolsConfiguration.terraform
Properties
| Property | Type | Required |
|---|---|---|
| state | object | Required |
.spec.toolsConfiguration.terraform.state
Properties
| Property | Type | Required |
|---|---|---|
| s3 | object | Required |
.spec.toolsConfiguration.terraform.state.s3
Properties
| Property | Type | Required |
|---|---|---|
| bucketName | Merged | Required |
| keyPrefix | string | Required |
| region | string | Required |
| skipRegionValidation | boolean | Optional |
.spec.toolsConfiguration.terraform.state.s3.bucketName
Description
This value defines which bucket will be used to store all the states
Constraints
pattern: the string must match the following regular expression:
^[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]$
and it must not match the following regular expression:
^xn--|-s3alias$
.spec.toolsConfiguration.terraform.state.s3.keyPrefix
Description
This value defines which folder will be used to store all the states inside the bucket
Constraints
maximum length: the maximum number of characters for this string is: 960
pattern: the string must match the following regular expression:
^[A-z0-9][A-z0-9!-_.*'()]+$
.spec.toolsConfiguration.terraform.state.s3.region
Description
This value defines in which region the bucket is located
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"af-south-1" |
"ap-east-1" |
"ap-northeast-1" |
"ap-northeast-2" |
"ap-northeast-3" |
"ap-south-1" |
"ap-south-2" |
"ap-southeast-1" |
"ap-southeast-2" |
"ap-southeast-3" |
"ap-southeast-4" |
"ca-central-1" |
"eu-central-1" |
"eu-central-2" |
"eu-north-1" |
"eu-south-1" |
"eu-south-2" |
"eu-west-1" |
"eu-west-2" |
"eu-west-3" |
"me-central-1" |
"me-south-1" |
"sa-east-1" |
"us-east-1" |
"us-east-2" |
"us-gov-east-1" |
"us-gov-west-1" |
"us-west-1" |
"us-west-2" |
.spec.toolsConfiguration.terraform.state.s3.skipRegionValidation
Description
This value defines if the region of the bucket should be validated or not by Terraform, useful when using a bucket in a recently added region
.spec.infrastructure
Properties
| Property | Type | Required |
|---|---|---|
| vpc | object | Optional* |
| vpn | object | Optional |
*vpc: if omitted, you need to provide vpcId and subnetIds in .spec.kubernetes*, and vpcId in .spec.infrastructure.vpn*
.spec.infrastructure.vpc
Description
This key defines the VPC that will be created in AWS
Properties
| Property | Type | Required |
|---|---|---|
| network | object | Required |
.spec.infrastructure.vpc.network
Properties
| Property | Type | Required |
|---|---|---|
| cidr | string | Required |
| subnetsCidrs | object | Required |
.spec.infrastructure.vpc.network.cidr
Description
This is the CIDR of the VPC that will be created
Constraints
pattern: the string must match the following regular expression:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.infrastructure.vpc.network.subnetsCidrs
Properties
| Property | Type | Required |
|---|---|---|
| private | array | Required |
| public | array | Required |
.spec.infrastructure.vpc.network.subnetsCidrs.private
Description
These are the CIRDs for the private subnets, where the nodes, the pods, and the private load balancers will be created
Constraints
pattern: the string must match the following regular expression:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.infrastructure.vpc.network.subnetsCidrs.public
Description
These are the CIDRs for the public subnets, where the public load balancers and the VPN servers will be created
Constraints
pattern: the string must match the following regular expression:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.infrastructure.vpn
Description
This section defines the creation of VPN bastions
Properties
| Property | Type | Required |
|---|---|---|
| instances | integer | Optional |
| port | integer | Optional |
| instanceType | string | Optional |
| diskSize | integer | Optional |
| operatorName | string | Optional |
| dhParamsBits | integer | Optional |
| vpnClientsSubnetCidr | string | Required |
| ssh | object | Required |
| vpcId | string | Optional* |
| bucketNamePrefix | Merged | Optional |
vpcId: required only if .spec.infrastructure.vpc is omitted
.spec.infrastructure.vpn.instances
Description
The number of instances to create, 0 to skip the creation
.spec.infrastructure.vpn.port
Description
The port used by the OpenVPN server
Constraints
maximum: the value of this property must be lower or equal to 65535
minimum: the value of this property must be higher or equal to 1
.spec.infrastructure.vpn.instanceType
Description
The size of the AWS EC2 instance
.spec.infrastructure.vpn.diskSize
Description
The size of the disk in GB
.spec.infrastructure.vpn.operatorName
Description
The username of the account to create in the bastion's operating system
.spec.infrastructure.vpn.dhParamsBits
Description
The dhParamsBits size used for the creation of the .pem file that will be used in the dh openvpn server.conf file
.spec.infrastructure.vpn.vpnClientsSubnetCidr
Description
The CIDR that will be used to assign IP addresses to the VPN clients when connected
Constraints
pattern: the string must match the following regular expression:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.infrastructure.vpn.ssh
Properties
| Property | Type | Required |
|---|---|---|
| publicKeys | array | Optional |
| githubUsersName | array | Required |
| allowedFromCidrs | array | Required |
.spec.infrastructure.vpn.ssh.publicKeys
Description
This value defines the public keys that will be added to the bastion's operating system
NOTES: Not yet implemented
.spec.infrastructure.vpn.ssh.githubUsersName
Description
The github user name list that will be used to get the ssh public key that will be added as authorized key to the operatorName user
Constraints
minimum number of items: the minimum number of items for this array is: 1
.spec.infrastructure.vpn.ssh.allowedFromCidrs
Description
The CIDR enabled in the security group that can access the bastions in SSH
Constraints
minimum number of items: the minimum number of items for this array is: 1
elements of the array must adhere to the following pattern:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.infrastructure.vpn.vpcId
Description
The VPC ID where the VPN servers will be created, required only if .spec.infrastructure.vpc is omitted
Constraints
pattern: the string must match the following regular expression:
^vpc\-([0-9a-f]{8}|[0-9a-f]{17})$
.spec.infrastructure.vpn.bucketNamePrefix
Description
This value defines the prefix that will be used to create the bucket name where the VPN servers will store the states
Constraints
pattern: the string must match the following regular expression:
^[a-z0-9][a-z0-9-.]{1,35}[a-z0-9-.]$
and it must not match the following regular expression:
^xn--|-s3alias$
.spec.kubernetes
Properties
| Property | Type | Required |
|---|---|---|
| vpcId | string | Optional |
| subnetIds | array | Optional |
| apiServer | object | Required |
| serviceIpV4Cidr | string | Optional |
| nodeAllowedSshPublicKey | string | Required |
| nodePoolsLaunchKind | string | Required |
| logRetentionDays | integer | Optional |
| logsTypes | array | Optional |
| nodePools | array | Required |
| awsAuth | object | Optional |
vpcId: required only if .spec.infrastructure.vpc is omitted subnetIds: required only if .spec.infrastructure.vpc is omitted
.spec.kubernetes.vpcId
Description
This value defines the VPC ID where the EKS cluster will be created, required only if .spec.infrastructure.vpc is omitted
Constraints
pattern: the string must match the following regular expression:
^vpc\-([0-9a-f]{8}|[0-9a-f]{17})$
.spec.kubernetes.subnetIds
Description
This value defines the subnet IDs where the EKS cluster will be created, required only if .spec.infrastructure.vpc is omitted
Constraints
pattern: the string must match the following regular expression:
^subnet\-[0-9a-f]{17}$
.spec.kubernetes.apiServer
Properties
| Property | Type | Required |
|---|---|---|
| privateAccess | boolean | Required |
| privateAccessCidrs | array | Optional |
| publicAccessCidrs | array | Optional |
| publicAccess | boolean | Required |
.spec.kubernetes.apiServer.privateAccess
Description
This value defines if the API server will be accessible only from the private subnets
.spec.kubernetes.apiServer.privateAccessCidrs
Description
This value defines the CIDRs that will be allowed to access the API server from the private subnets
Constraints
minimum number of items: the minimum number of items for this array is: 0
elements of the array must adhere to the following pattern:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.kubernetes.apiServer.publicAccessCidrs
Description
This value defines the CIDRs that will be allowed to access the API server from the public subnets
Constraints
minimum number of items: the minimum number of items for this array is: 0
elements of the array must adhere to the following pattern:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.kubernetes.apiServer.publicAccess
Description
This value defines if the API server will be accessible from the public subnets
.spec.kubernetes.serviceIpV4Cidr
Description
This value defines the CIDR that will be used to assign IP addresses to the services
Constraints
pattern: the string must match the following regular expression:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.kubernetes.nodeAllowedSshPublicKey
Description
This key contains the ssh public key that can connect to the nodes via SSH using the ec2-user user
Constraints
pattern: the string must match either the following regular expression:
^ssh\-(ed25519|rsa)\s+
or the following regular expression:
^\{file\:\/\/.+\}$
.spec.kubernetes.nodePoolsLaunchKind
Description
Either launch_configurations, launch_templates or both. For new clusters use launch_templates, for existing cluster you'll need to migrate from launch_configurations to launch_templates using both as interim.
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"launch_configurations" |
"launch_templates" |
"both" |
.spec.kubernetes.logRetentionDays
Description
Optional Kubernetes Cluster log retention in days. Defaults to 90 days.
.spec.kubernetes.logsTypes
Description
Optional list of Kubernetes Cluster log types to enable. Defaults to all types.
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"api" |
"audit" |
"authenticator" |
"controllerManager" |
"scheduler" |
.spec.kubernetes.nodePools
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
| type | string | Optional |
| ami | object | Optional |
| containerRuntime | string | Optional |
| size | object | Required |
| instance | object | Required |
| attachedTargetGroups | array | Optional |
| labels | object | Optional |
| taints | array | Optional |
| tags | object | Optional |
| subnetIds | array | Optional |
| additionalFirewallRules | object | Optional |
.spec.kubernetes.nodePools.name
Description
The name of the node pool
.spec.kubernetes.nodePools.ami
Properties
| Property | Type | Required |
|---|---|---|
| id | string | Required |
| owner | string | Required |
.spec.kubernetes.nodePools.ami.id
Description
The AMI ID to use for the nodes
.spec.kubernetes.nodePools.ami.owner
Description
The owner of the AMI
.spec.kubernetes.nodePools.containerRuntime
Description
The container runtime to use for the nodes
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"docker" |
"containerd" |
.spec.kubernetes.nodePools.size
Properties
| Property | Type | Required |
|---|---|---|
| max | integer | Required |
| min | integer | Required |
.spec.kubernetes.nodePools.size.max
Description
The maximum number of nodes in the node pool
Constraints
minimum: the value of this property must be higher or equal to 0
.spec.kubernetes.nodePools.size.min
Description
The minimum number of nodes in the node pool
Constraints
minimum: the value of this property must be higher or equal to 0
.spec.kubernetes.nodePools.instance
Properties
| Property | Type | Required |
|---|---|---|
| type | string | Required |
| spot | boolean | Optional |
| volumeSize | integer | Optional |
.spec.kubernetes.nodePools.instance.type
Description
The instance type to use for the nodes
.spec.kubernetes.nodePools.instance.spot
Description
If true, the nodes will be created as spot instances
.spec.kubernetes.nodePools.instance.volumeSize
Description
The size of the disk in GB
.spec.kubernetes.nodePools.attachedTargetGroups
Description
This optional array defines additional target groups to attach to the instances in the node pool
Constraints
minimum number of items: the minimum number of items for this array is: 0
elements of the array must adhere to the following pattern:
^arn:(?P<Partition>[^:\n]*):(?P<Service>[^:\n]*):(?P<Region>[^:\n]*):(?P<AccountID>[^:\n]*):(?P<Ignore>(?P<ResourceType>[^:\/\n]*)[:\/])?(?P<Resource>.*)$
.spec.kubernetes.nodePools.labels
Description
Kubernetes labels that will be added to the nodes
.spec.kubernetes.nodePools.taints
Description
Kubernetes taints that will be added to the nodes
Constraints
minimum number of items: the minimum number of items for this array is: 0
elements of the array must adhere to the following pattern:
^([a-zA-Z0-9\-\.\/]+)=(\w+):(NoSchedule|PreferNoSchedule|NoExecute)$
.spec.kubernetes.nodePools.tags
Description
AWS tags that will be added to the ASG and EC2 instances
.spec.kubernetes.nodePools.subnetIds
Description
This value defines the subnet IDs where the nodes will be created
Constraints
minimum number of items: the minimum number of items for this array is: 0
elements of the array must adhere to the following pattern:
^subnet\-[0-9a-f]{17}$
.spec.kubernetes.nodePools.additionalFirewallRules
Properties
| Property | Type | Required |
|---|---|---|
| cidrBlocks | array | Optional |
| sourceSecurityGroupId | array | Optional |
| self | array | Optional |
.spec.kubernetes.nodePools.additionalFirewallRules.cidrBlocks
Description
The CIDR blocks for the FW rule. At the moment the first item of the list will be used, others will be ignored.
Constraints
minimum number of items: the minimum number of items for this array is: 1
elements of the array must adhere to the following pattern:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}\/(3[0-2]|[1-2][0-9]|[0-9])$
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
| type | string | Required |
| tags | object | Optional |
| sourceSecurityGroupId | string | Required |
| protocol | string | Required |
| ports | object | Required |
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.name
Description
The name of the FW rule
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.type
Description
The type of the FW rule can be ingress or egress
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"ingress" |
"egress" |
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.tags
Description
The tags of the FW rule
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.sourceSecurityGroupId
Description
The source security group ID
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.protocol
Description
The protocol of the FW rule
Constraints
this value should be lowercase, but we rely on terraform to do the conversion to make it a bit more user-friendly
pattern: the string must match the following regular expression:
^(?i)(tcp|udp|icmp|icmpv6|-1)$
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.ports
Properties
| Property | Type | Required |
|---|---|---|
| from | integer | Required |
| to | integer | Required |
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.ports.from
Constraints
maximum: the value of this property must be lower or equal to 65535
minimum: the value of this property must be higher or equal to 1
.spec.kubernetes.nodePools.additionalFirewallRules.sourceSecurityGroupId.ports.to
Constraints
maximum: the value of this property must be lower or equal to 65535
minimum: the value of this property must be higher or equal to 1
.spec.kubernetes.nodePools.additionalFirewallRules.self
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
| type | string | Required |
| tags | object | Optional |
| self | boolean | Required |
| protocol | string | Required |
| ports | object | Required |
.spec.kubernetes.nodePools.additionalFirewallRules.self.name
Description
The name of the FW rule
.spec.kubernetes.nodePools.additionalFirewallRules.self.type
Description
The type of the FW rule can be ingress or egress
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"ingress" |
"egress" |
.spec.kubernetes.nodePools.additionalFirewallRules.self.tags
Description
The tags of the FW rule
.spec.kubernetes.nodePools.additionalFirewallRules.self.self
Description
If true, the source will be the security group itself
.spec.kubernetes.nodePools.additionalFirewallRules.self.protocol
Description
The protocol of the FW rule
Constraints
this value should be lowercase, but we rely on terraform to do the conversion to make it a bit more user-friendly
pattern: the string must match the following regular expression:
^(?i)(tcp|udp|icmp|icmpv6|-1)$
.spec.kubernetes.nodePools.additionalFirewallRules.self.ports
Properties
| Property | Type | Required |
|---|---|---|
| from | integer | Required |
| to | integer | Required |
.spec.kubernetes.nodePools.additionalFirewallRules.self.ports.from
Constraints
maximum: the value of this property must be lower or equal to 65535
minimum: the value of this property must be higher or equal to 1
.spec.kubernetes.nodePools.additionalFirewallRules.self.ports.to
Constraints
maximum: the value of this property must be lower or equal to 65535
minimum: the value of this property must be higher or equal to 1
.spec.kubernetes.awsAuth
Properties
| Property | Type | Required |
|---|---|---|
| additionalAccounts | array | Optional |
| users | array | Optional |
| roles | array | Optional |
.spec.kubernetes.awsAuth.additionalAccounts
Description
This optional array defines additional AWS accounts that will be added to the aws-auth configmap
.spec.kubernetes.awsAuth.users
Description
This optional array defines additional IAM users that will be added to the aws-auth configmap
.spec.kubernetes.awsAuth.roles
Description
This optional array defines additional IAM roles that will be added to the aws-auth configmap
.spec.distribution
Properties
| Property | Type | Required |
|---|---|---|
| common | object | Optional |
| modules | object | Required |
| customPatches | object | Optional |
.spec.distribution.common
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| provider | object | Optional |
| relativeVendorPath | string | Optional |
.spec.distribution.common.nodeSelector
Description
The node selector to use to place the pods for all the KFD modules
.spec.distribution.common.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for all the KFD modules
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.common.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.common.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.common.tolerations.key
Description
The key of the toleration
.spec.distribution.common.tolerations.value
Description
The value of the toleration
.spec.distribution.common.provider
Properties
| Property | Type | Required |
|---|---|---|
| type | string | Required |
.spec.distribution.common.provider.type
Description
The type of the provider, must be EKS if specified
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"EKS" |
.spec.distribution.common.relativeVendorPath
Description
The relative path to the vendor directory, does not need to be changed
.spec.distribution.modules
Properties
| Property | Type | Required |
|---|---|---|
| auth | object | Optional |
| aws | object | Optional |
| dr | object | Required |
| ingress | object | Required |
| logging | object | Required |
| monitoring | object | Optional |
| networking | object | Optional |
| policy | object | Required |
| tracing | object | Optional |
.spec.distribution.modules.auth
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| provider | object | Required |
| baseDomain | string | Optional* |
| pomerium | object | Optional* |
| dex | object | Optional* |
*required only if .spec.distribution.modules.auth.provider.type is sso, otherwise it must be null*
.spec.distribution.modules.auth.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.auth.overrides.nodeSelector
Description
The node selector to use to place the pods for the auth module
.spec.distribution.modules.auth.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the auth module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.auth.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.auth.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.auth.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.auth.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.auth.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Required |
| ingressClass | string | Required |
| disableAuth | boolean | Optional |
.spec.distribution.modules.auth.overrides.ingresses.host
Description
The host of the ingress
.spec.distribution.modules.auth.overrides.ingresses.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.auth.overrides.ingresses.disableAuth
Description
If true, the auth will be disabled for the ingress
.spec.distribution.modules.auth.provider
Properties
| Property | Type | Required |
|---|---|---|
| type | string | Required |
| basicAuth | object | Optional* |
*basicAuth is required only if .spec.distribution.modules.auth.provider.type is basicAuth, otherwise it must be null*
.spec.distribution.modules.auth.provider.type
Description
The type of the provider, must be none, sso or basicAuth
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"sso" |
"basicAuth" |
.spec.distribution.modules.auth.provider.basicAuth
Properties
| Property | Type | Required |
|---|---|---|
| username | string | Required |
| password | string | Required |
.spec.distribution.modules.auth.provider.basicAuth.username
Description
The username for the basic auth
.spec.distribution.modules.auth.provider.basicAuth.password
Description
The password for the basic auth
.spec.distribution.modules.auth.baseDomain
Description
The base domain for the auth module
.spec.distribution.modules.auth.pomerium
Properties
| Property | Type | Required |
|---|---|---|
| secrets | object | Required |
| policy | string | Required |
| overrides | object | Optional |
.spec.distribution.modules.auth.pomerium.secrets
Properties
| Property | Type | Required |
|---|---|---|
| COOKIE_SECRET | string | Required |
| IDP_CLIENT_SECRET | string | Required |
| SHARED_SECRET | string | Required |
.spec.distribution.modules.auth.pomerium.secrets.COOKIE_SECRET
Description
The cookie secret for pomerium
.spec.distribution.modules.auth.pomerium.secrets.IDP_CLIENT_SECRET
Description
The IDP client secret for pomerium
.spec.distribution.modules.auth.pomerium.secrets.SHARED_SECRET
Description
The shared secret for pomerium
.spec.distribution.modules.auth.pomerium.policy
Description
The policy for pomerium
.spec.distribution.modules.auth.pomerium.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.auth.pomerium.overrides.nodeSelector
Description
The node selector to use to place the pods for the pomerium module
.spec.distribution.modules.auth.pomerium.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the pomerium module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.auth.pomerium.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.auth.pomerium.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.auth.pomerium.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.auth.pomerium.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.auth.dex
Properties
| Property | Type | Required |
|---|---|---|
| connectors | array | Required |
| additionalStaticClients | array | Optional |
| overrides | object | Optional |
.spec.distribution.modules.auth.dex.connectors
Description
The connectors for dex
.spec.distribution.modules.auth.dex.additionalStaticClients
Description
The additional static clients for dex
.spec.distribution.modules.auth.dex.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.auth.dex.overrides.nodeSelector
Description
The node selector to use to place the pods for the dex module
.spec.distribution.modules.auth.dex.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the dex module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.auth.dex.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.auth.dex.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.auth.dex.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.auth.dex.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.aws
Properties
| Property | Type | Required |
|---|---|---|
| clusterAutoscaler | object | Optional |
| ebsCsiDriver | object | Optional |
| loadBalancerController | object | Optional |
| ebsSnapshotController | object | Optional |
| overrides | object | Optional |
.spec.distribution.modules.aws.clusterAutoscaler
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.aws.clusterAutoscaler.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.aws.clusterAutoscaler.overrides.nodeSelector
Description
The node selector to use to place the pods for the cluster autoscaler module
.spec.distribution.modules.aws.clusterAutoscaler.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the cluster autoscaler module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.aws.clusterAutoscaler.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.aws.clusterAutoscaler.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.aws.clusterAutoscaler.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.aws.clusterAutoscaler.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.aws.ebsCsiDriver
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.aws.ebsCsiDriver.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.aws.ebsCsiDriver.overrides.nodeSelector
Description
The node selector to use to place the pods for the ebs csi driver module
.spec.distribution.modules.aws.ebsCsiDriver.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the ebs csi driver module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.aws.ebsCsiDriver.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.aws.ebsCsiDriver.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.aws.ebsCsiDriver.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.aws.ebsCsiDriver.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.aws.loadBalancerController
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.aws.loadBalancerController.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.aws.loadBalancerController.overrides.nodeSelector
Description
The node selector to use to place the pods for the load balancer controller module
.spec.distribution.modules.aws.loadBalancerController.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the load balancer controller module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.aws.loadBalancerController.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.aws.loadBalancerController.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.aws.loadBalancerController.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.aws.loadBalancerController.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.aws.ebsSnapshotController
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.aws.ebsSnapshotController.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.aws.ebsSnapshotController.overrides.nodeSelector
Description
The node selector to use to place the pods for the ebs snapshot controller module
.spec.distribution.modules.aws.ebsSnapshotController.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the ebs snapshot controller module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.aws.ebsSnapshotController.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.aws.ebsSnapshotController.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.aws.ebsSnapshotController.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.aws.ebsSnapshotController.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.aws.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.aws.overrides.nodeSelector
Description
The node selector to use to place the pods for all the AWS modules
.spec.distribution.modules.aws.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for all the AWS modules
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.aws.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.aws.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.aws.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.aws.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.aws.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Required |
| ingressClass | string | Required |
| disableAuth | boolean | Optional |
.spec.distribution.modules.aws.overrides.ingresses.host
Description
The host of the ingress
.spec.distribution.modules.aws.overrides.ingresses.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.aws.overrides.ingresses.disableAuth
Description
If true, the auth will be disabled for the ingress
.spec.distribution.modules.dr
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| type | string | Required |
| velero | object | Optional* |
*velero: required only if .spec.distribution.modules.dr.type is eks, otherwise it must be null*
.spec.distribution.modules.dr.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.dr.overrides.nodeSelector
Description
The node selector to use to place the pods for the dr module
.spec.distribution.modules.dr.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the dr module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.dr.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.dr.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.dr.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.dr.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.dr.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Required |
| ingressClass | string | Required |
| disableAuth | boolean | Optional |
.spec.distribution.modules.dr.overrides.ingresses.host
Description
The host of the ingress
.spec.distribution.modules.dr.overrides.ingresses.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.dr.overrides.ingresses.disableAuth
Description
If true, the ingress will not have authentication
.spec.distribution.modules.dr.type
Description
The type of the DR, must be none or eks
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"eks" |
.spec.distribution.modules.dr.velero
Properties
| Property | Type | Required |
|---|---|---|
| eks | object | Required |
| overrides | object | Optional |
.spec.distribution.modules.dr.velero.eks
Properties
| Property | Type | Required |
|---|---|---|
| region | string | Required |
| bucketName | string | Required |
.spec.distribution.modules.dr.velero.eks.region
Description
The region where the velero bucket is located
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"af-south-1" |
"ap-east-1" |
"ap-northeast-1" |
"ap-northeast-2" |
"ap-northeast-3" |
"ap-south-1" |
"ap-south-2" |
"ap-southeast-1" |
"ap-southeast-2" |
"ap-southeast-3" |
"ap-southeast-4" |
"ca-central-1" |
"eu-central-1" |
"eu-central-2" |
"eu-north-1" |
"eu-south-1" |
"eu-south-2" |
"eu-west-1" |
"eu-west-2" |
"eu-west-3" |
"me-central-1" |
"me-south-1" |
"sa-east-1" |
"us-east-1" |
"us-east-2" |
"us-gov-east-1" |
"us-gov-west-1" |
"us-west-1" |
"us-west-2" |
.spec.distribution.modules.dr.velero.eks.bucketName
Description
The name of the velero bucket
Constraints
maxLength: the string must be shorter than or equal to 49 characters
pattern: the string must match the following regular expression:
^[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]$
and it must not match the following regular expression:
^xn--|-s3alias$
.spec.distribution.modules.dr.velero.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.dr.velero.overrides.nodeSelector
Description
The node selector to use to place the pods for the velero module
.spec.distribution.modules.dr.velero.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the velero module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.dr.velero.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.dr.velero.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.dr.velero.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.dr.velero.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.ingress
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| baseDomain | string | Required |
| nginx | object | Required |
| certManager | object | Optional* |
| forecastle | object | Optional |
| dns | object | Required |
*certManager: required only if .spec.distribution.modules.ingress.nginx.tls.provider is *certManager**
.spec.distribution.modules.ingress.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.ingress.overrides.nodeSelector
Description
The node selector to use to place the pods for the ingress module
.spec.distribution.modules.ingress.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the ingress module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.ingress.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.ingress.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.ingress.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.ingress.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.ingress.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| forecastle | object | Optional |
.spec.distribution.modules.ingress.overrides.ingresses.forecastle
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Optional |
| ingressClass | string | Optional |
| disableAuth | boolean | Optional |
.spec.distribution.modules.ingress.overrides.ingresses.forecastle.host
Description
The host of the ingress
.spec.distribution.modules.ingress.overrides.ingresses.forecastle.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.ingress.overrides.ingresses.forecastle.disableAuth
Description
If true, auth will be disabled for the ingress
.spec.distribution.modules.ingress.overrides.ingresses.nodeSelector
Description
The node selector to use to place the pods for the ingress module
.spec.distribution.modules.ingress.overrides.ingresses.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the ingress module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.ingress.overrides.ingresses.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.ingress.overrides.ingresses.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.ingress.overrides.ingresses.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.ingress.overrides.ingresses.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.ingress.baseDomain
Description
the base domain used for all the KFD ingresses, if in the nginx dual configuration, it should be the same as the .spec.distribution.modules.ingress.dns.private.name zone
.spec.distribution.modules.ingress.nginx
Description
Configurations for the nginx ingress controller module
Properties
| Property | Type | Required |
|---|---|---|
| type | string | Required |
| tls | object | Optional |
| overrides | object | Optional |
.spec.distribution.modules.ingress.nginx.type
Description
The type of the nginx ingress controller, must be none, single or dual
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"single" |
"dual" |
.spec.distribution.modules.ingress.nginx.tls
Properties
| Property | Type | Required |
|---|---|---|
| provider | string | Required |
| secret | object | Optional* |
*secret: required only if .spec.distribution.modules.ingress.nginx.tls.provider is *secret**
.spec.distribution.modules.ingress.nginx.tls.provider
Description
The provider of the TLS certificate, must be none, certManager or secret
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"certManager" |
"secret" |
.spec.distribution.modules.ingress.nginx.tls.secret
Properties
| Property | Type | Required |
|---|---|---|
| cert | string | Required |
| key | string | Required |
| ca | string | Required |
.spec.distribution.modules.ingress.nginx.tls.secret.cert
Description
The certificate file content or you can use the file notation to get the content from a file
.spec.distribution.modules.ingress.nginx.tls.secret.key
The key file, a file notation can be used to get the content from a file
.spec.distribution.modules.ingress.nginx.tls.secret.ca
The ca file, a file notation can be used to get the content from a file
.spec.distribution.modules.ingress.nginx.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.ingress.nginx.overrides.nodeSelector
Description
The node selector to use to place the pods for the nginx module
.spec.distribution.modules.ingress.nginx.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the nginx module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.ingress.nginx.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.ingress.nginx.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.ingress.nginx.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.ingress.nginx.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.ingress.certManager
Properties
| Property | Type | Required |
|---|---|---|
| clusterIssuer | Merged | Required |
| overrides | object | Optional |
.spec.distribution.modules.ingress.certManager.clusterIssuer
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
string | Required | |
| type | string | Optional |
| solvers | array | Optional |
*type and solvers cannot be set at the same time*
.spec.distribution.modules.ingress.certManager.clusterIssuer.name
Description
The name of the cluster issuer
.spec.distribution.modules.ingress.certManager.clusterIssuer.email
Description
The email of the cluster issuer
.spec.distribution.modules.ingress.certManager.clusterIssuer.type
Description
The type of the cluster issuer, must be dns01 or http01
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"dns01" |
"http01" |
.spec.distribution.modules.ingress.certManager.clusterIssuer.solvers
Description
The custom solvers configurations
.spec.distribution.modules.ingress.certManager.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.ingress.certManager.overrides.nodeSelector
Description
The node selector to use to place the pods for the cert-manager module
.spec.distribution.modules.ingress.certManager.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the cert-manager module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.ingress.certManager.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.ingress.certManager.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.ingress.certManager.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.ingress.certManager.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.ingress.forecastle
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.ingress.forecastle.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.ingress.forecastle.overrides.nodeSelector
Description
The node selector to use to place the pods for the forecastle module
.spec.distribution.modules.ingress.forecastle.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the forecastle module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.ingress.dns
Properties
| Property | Type | Required |
|---|---|---|
| private | object | Required |
| public | object | Required |
| overrides | object | Optional |
.spec.distribution.modules.ingress.dns.private
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
| create | boolean | Required |
.spec.distribution.modules.ingress.dns.private.name
Description
The name of the private hosted zone
.spec.distribution.modules.ingress.dns.private.create
Description
If true, the private hosted zone will be created
.spec.distribution.modules.ingress.dns.public
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
| create | boolean | Required |
.spec.distribution.modules.ingress.dns.public.name
Description
The name of the public hosted zone
.spec.distribution.modules.ingress.dns.public.create
Description
If true, the public hosted zone will be created
.spec.distribution.modules.ingress.dns.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.ingress.dns.overrides.nodeSelector
Description
The node selector to use to place the pods for the ingress module
.spec.distribution.modules.ingress.dns.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Optional |
Description
The tolerations that will be added to the pods for the ingress module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.ingress.dns.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.ingress.dns.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.ingress.dns.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.ingress.dns.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.logging
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| type | string | Required |
| opensearch | object | Optional* |
| loki | object | Optional |
| cerebro | object | Optional |
| minio | object | Optional |
| operator | object | Optional |
*opensearch: required only if .spec.distribution.modules.logging.type is *opensearch**
.spec.distribution.modules.logging.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.logging.overrides.nodeSelector
Description
The node selector to use to place the pods for the logging module
.spec.distribution.modules.logging.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Optional |
Description
The tolerations that will be added to the pods for the logging module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.logging.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.logging.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.logging.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.logging.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.logging.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Required |
| ingressClass | string | Required |
| disableAuth | boolean | Optional |
.spec.distribution.modules.logging.overrides.ingresses.host
Description
The host of the ingress
.spec.distribution.modules.logging.overrides.ingresses.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.logging.overrides.ingresses.disableAuth
Description
If true, the ingress will not have authentication
.spec.distribution.modules.logging.type
Description
The type of the logging, must be none, opensearch or loki
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"opensearch" |
"loki" |
.spec.distribution.modules.logging.opensearch
Properties
| Property | Type | Required |
|---|---|---|
| type | string | Required |
| resources | object | Optional |
| storageSize | string | Optional |
| overrides | object | Optional |
.spec.distribution.modules.logging.opensearch.type
Description
The type of the opensearch, must be single or triple
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"single" |
"triple" |
.spec.distribution.modules.logging.opensearch.resources
Properties
| Property | Type | Required |
|---|---|---|
| requests | object | Optional |
| limits | object | Optional |
.spec.distribution.modules.logging.opensearch.resources.requests
Properties
| Property | Type | Required |
|---|---|---|
| cpu | string | Optional |
| memory | string | Optional |
.spec.distribution.modules.logging.opensearch.resources.requests.cpu
Description
The cpu request for the opensearch pods
.spec.distribution.modules.logging.opensearch.resources.requests.memory
Description
The memory request for the opensearch pods
.spec.distribution.modules.logging.opensearch.resources.limits
Properties
| Property | Type | Required |
|---|---|---|
| cpu | string | Optional |
| memory | string | Optional |
.spec.distribution.modules.logging.opensearch.resources.limits.cpu
Description
The cpu limit for the opensearch pods
.spec.distribution.modules.logging.opensearch.resources.limits.memory
Description
The memory limit for the opensearch pods
.spec.distribution.modules.logging.opensearch.storageSize
Description
The storage size for the opensearch pods
.spec.distribution.modules.logging.opensearch.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.logging.opensearch.overrides.nodeSelector
Description
The node selector to use to place the pods for the opensearch module
.spec.distribution.modules.logging.opensearch.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the opensearch module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.logging.opensearch.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.logging.opensearch.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
"Exists" |
.spec.distribution.modules.logging.opensearch.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.logging.opensearch.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.logging.loki
Properties
| Property | Type | Required |
|---|---|---|
| resources | object | Optional |
| backend | object | Optional |
| externalEndpoint | string | Optional |
.spec.distribution.modules.logging.loki.resources
Properties
| Property | Type | Required |
|---|---|---|
| requests | object | Optional |
| limits | object | Optional |
.spec.distribution.modules.logging.loki.resources.requests
Properties
| Property | Type | Required |
|---|---|---|
| cpu | string | Optional |
| memory | string | Optional |
.spec.distribution.modules.logging.loki.resources.requests.cpu
Description
The cpu request for the loki pods
.spec.distribution.modules.logging.loki.resources.requests.memory
Description
The memory request for the loki pods
.spec.distribution.modules.logging.loki.resources.limits
Properties
| Property | Type | Required |
|---|---|---|
| cpu | string | Optional |
| memory | string | Optional |
.spec.distribution.modules.logging.loki.resources.limits.cpu
Description
The cpu limit for the loki pods
.spec.distribution.modules.logging.loki.resources.limits.memory
Description
The memory limit for the loki pods
.spec.distribution.modules.logging.loki.backend
Properties
| Property | Type | Required |
|---|---|---|
| type | string | Required |
.spec.distribution.modules.logging.loki.backend.type
Description
The type of the loki backend, must be minio or externalEndpoint
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"minio" |
"externalEndpoint" |
.spec.distribution.modules.logging.loki.externalEndpoint
Properties
| Property | Type | Required |
|---|---|---|
| endpoint | string | Required |
| insecure | boolean | Optional |
| secretAccessKey | string | Optional |
| accessKeyId | string | Optional |
| bucketName | string | Optional |
.spec.distribution.modules.logging.loki.externalEndpoint.endpoint
Description
The endpoint of the loki external endpoint
.spec.distribution.modules.logging.loki.externalEndpoint.insecure
Description
If true, the loki external endpoint will be insecure
.spec.distribution.modules.logging.loki.externalEndpoint.secretAccessKey
Description
The secret access key of the loki external endpoint
.spec.distribution.modules.logging.loki.externalEndpoint.accessKeyId
Description
The access key id of the loki external endpoint
.spec.distribution.modules.logging.loki.externalEndpoint.bucketName
Description
The bucket name of the loki external endpoint
.spec.distribution.modules.logging.cerebro
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.logging.cerebro.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.logging.cerebro.overrides.nodeSelector
Description
The node selector to use to place the pods for the cerebro module
.spec.distribution.modules.logging.cerebro.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the cerebro module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.logging.cerebro.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.logging.cerebro.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.logging.cerebro.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.logging.cerebro.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.logging.minio
Properties
| Property | Type | Required |
|---|---|---|
| storageSize | string | Optional |
| overrides | object | Optional |
| rootUser | object | Optional |
.spec.distribution.modules.logging.minio.storageSize
Description
The PVC size for each minio disk, 6 disks total
.spec.distribution.modules.logging.minio.rootUser
Properties
| Property | Type | Required |
|---|---|---|
| username | string | Required |
| password | string | Required |
.spec.distribution.modules.logging.minio.rootUser.username
Description
The username of the minio root user
.spec.distribution.modules.logging.minio.rootUser.password
Description
The password of the minio root user
.spec.distribution.modules.logging.minio.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.logging.minio.overrides.nodeSelector
Description
The node selector to use to place the pods for the minio module
.spec.distribution.modules.logging.minio.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the minio module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.logging.minio.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.logging.minio.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.logging.minio.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.logging.minio.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.logging.operator
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.logging.operator.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.logging.operator.overrides.nodeSelector
Description
The node selector to use to place the pods for the operator module
.spec.distribution.modules.logging.operator.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the operator module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.logging.operator.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.logging.operator.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.logging.operator.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.logging.operator.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring
Properties
| Property | Type | Required |
|---|---|---|
| type | string | Required |
| overrides | object | Optional |
| prometheus | object | Optional |
| alertmanager | object | Optional |
| grafana | object | Optional |
| blackboxExporter | object | Optional |
| kubeStateMetrics | object | Optional |
| x509Exporter | object | Optional |
| mimir | object | Optional |
| minio | object | Optional |
.spec.distribution.modules.monitoring.type
Description
The type of the monitoring, must be none, prometheus or mimir
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"prometheus" |
"mimir" |
.spec.distribution.modules.monitoring.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.monitoring.overrides.nodeSelector
Description
The node selector to use to place the pods for the monitoring module
.spec.distribution.modules.monitoring.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the monitoring module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.monitoring.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.monitoring.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.monitoring.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.monitoring.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Required |
| ingressClass | string | Required |
| disableAuth | boolean | Optional |
.spec.distribution.modules.monitoring.overrides.ingresses.host
Description
The host of the ingress
.spec.distribution.modules.monitoring.overrides.ingresses.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.monitoring.overrides.ingresses.disableAuth
Description
If true, the ingress will not have authentication
.spec.distribution.modules.monitoring.prometheus
Properties
| Property | Type | Required |
|---|---|---|
| resources | object | Optional |
| retentionTime | string | Optional |
| retentionSize | string | Optional |
| storageSize | string | Optional |
.spec.distribution.modules.monitoring.prometheus.resources
Properties
| Property | Type | Required |
|---|---|---|
| requests | object | Optional |
| limits | object | Optional |
.spec.distribution.modules.monitoring.prometheus.resources.requests
Properties
| Property | Type | Required |
|---|---|---|
| cpu | string | Optional |
| memory | string | Optional |
.spec.distribution.modules.monitoring.prometheus.resources.requests.cpu
Description
The cpu request for the prometheus pods
.spec.distribution.modules.monitoring.prometheus.resources.requests.memory
Description
The memory request for the prometheus pods
.spec.distribution.modules.monitoring.prometheus.resources.limits
Properties
| Property | Type | Required |
|---|---|---|
| cpu | string | Optional |
| memory | string | Optional |
.spec.distribution.modules.monitoring.prometheus.resources.limits.cpu
Description
The cpu limit for the prometheus pods
.spec.distribution.modules.monitoring.prometheus.resources.limits.memory
Description
The memory limit for the prometheus pods
.spec.distribution.modules.monitoring.prometheus.retentionTime
Description
The retention time for the prometheus pods
.spec.distribution.modules.monitoring.prometheus.retentionSize
Description
The retention size for the prometheus pods
.spec.distribution.modules.monitoring.prometheus.storageSize
Description
The storage size for the prometheus pods
.spec.distribution.modules.monitoring.alertmanager
Properties
| Property | Type | Required |
|---|---|---|
| deadManSwitchWebhookUrl | string | Optional |
| installDefaultRules | boolean | Optional |
| slackWebhookUrl | string | Optional |
.spec.distribution.modules.monitoring.alertmanager.deadManSwitchWebhookUrl
Description
The webhook url to send deadman switch monitoring, for example to use with healthchecks.io
.spec.distribution.modules.monitoring.alertmanager.installDefaultRules
Description
If true, the default rules will be installed
.spec.distribution.modules.monitoring.alertmanager.slackWebhookUrl
Description
The slack webhook url to send alerts
.spec.distribution.modules.monitoring.grafana
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.monitoring.grafana.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.monitoring.grafana.overrides.nodeSelector
Description
The node selector to use to place the pods for the grafana module
.spec.distribution.modules.monitoring.grafana.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the grafana module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring.blackboxExporter
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.monitoring.blackboxExporter.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.monitoring.blackboxExporter.overrides.nodeSelector
Description
The node selector to use to place the pods for the blackboxExporter module
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the blackboxExporter module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring.kubeStateMetrics
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.nodeSelector
Description
The node selector to use to place the pods for the kubeStateMetrics module
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the kubeStateMetrics module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring.x509Exporter
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.monitoring.x509Exporter.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.monitoring.x509Exporter.overrides.nodeSelector
Description
The node selector to use to place the pods for the x509Exporter module
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the x509Exporter module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring.mimir
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| retentionTime | string | Optional |
| backend | string | Optional |
| externalEndpoint | object | Optional |
.spec.distribution.modules.monitoring.mimir.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.monitoring.mimir.overrides.nodeSelector
Description
The node selector to use to place the pods for the mimir module
.spec.distribution.modules.monitoring.mimir.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the mimir module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring.mimir.retentionTime
Description
The retention time for the mimir pods
.spec.distribution.modules.monitoring.mimir.backend
Description
The backend for the mimir pods, must be minio or externalEndpoint
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"minio" |
"externalEndpoint" |
.spec.distribution.modules.monitoring.mimir.externalEndpoint
Properties
| Property | Type | Required |
|---|---|---|
| endpoint | string | Required |
| insecure | boolean | Optional |
| secretAccessKey | string | Required |
| accessKeyId | string | Required |
| bucketName | string | Required |
.spec.distribution.modules.monitoring.mimir.externalEndpoint.endpoint
Description
The endpoint of the external mimir backend
.spec.distribution.modules.monitoring.mimir.externalEndpoint.insecure
Description
If true, the external mimir backend will not use tls
.spec.distribution.modules.monitoring.mimir.externalEndpoint.secretAccessKey
Description
The secret access key of the external mimir backend
.spec.distribution.modules.monitoring.mimir.externalEndpoint.accessKeyId
Description
The access key id of the external mimir backend
.spec.distribution.modules.monitoring.mimir.externalEndpoint.bucketName
Description
The bucket name of the external mimir backend
.spec.distribution.modules.monitoring.minio
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| storageSize | string | Optional |
| rootUser | object | Optional |
.spec.distribution.modules.monitoring.minio.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.monitoring.minio.overrides.nodeSelector
Description
The node selector to use to place the pods for the minio module
.spec.distribution.modules.monitoring.minio.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the minio module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.monitoring.minio.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.monitoring.minio.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.monitoring.minio.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.monitoring.minio.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.monitoring.minio.storageSize
Description
The storage size for the minio pods
.spec.distribution.modules.monitoring.minio.rootUser
Properties
| Property | Type | Required |
|---|---|---|
| username | string | Required |
| password | string | Required |
.spec.distribution.modules.monitoring.minio.rootUser.username
Description
The username for the minio root user
.spec.distribution.modules.monitoring.minio.rootUser.password
Description
The password for the minio root user
.spec.distribution.modules.networking
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| tigeraOperator | object | Optional |
.spec.distribution.modules.networking.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.networking.overrides.nodeSelector
Description
The node selector to use to place the pods for the networking module
.spec.distribution.modules.networking.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the networking module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.networking.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.networking.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.networking.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.networking.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.networking.tigeraOperator
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
.spec.distribution.modules.networking.tigeraOperator.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.networking.tigeraOperator.overrides.nodeSelector
Description
The node selector to use to place the pods for the tigeraOperator module
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the tigeraOperator module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.policy
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| type | string | Required |
| gatekeeper | object | Optional* |
| kyverno | object | Optional** |
*required if type is gatekeeper
required if type is *kyverno***
.spec.distribution.modules.policy.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.policy.overrides.nodeSelector
Description
The node selector to use to place the pods for the security module
.spec.distribution.modules.policy.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the policy module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.policy.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.policy.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.policy.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.policy.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.policy.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Required |
| ingressClass | string | Required |
.spec.distribution.modules.policy.overrides.ingresses.host
Description
The host of the ingress
.spec.distribution.modules.policy.overrides.ingresses.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.policy.type
Description
The type of security to use, either none, gatekeeper or kyverno
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"gatekeeper" |
"kyverno" |
.spec.distribution.modules.policy.gatekeeper
Properties
| Property | Type | Required |
|---|---|---|
| additionalExcludedNamespaces | array | Optional |
| enforcementAction | string | Required |
| installDefaultPolicies | boolean | Required |
| overrides | object | Optional |
.spec.distribution.modules.policy.gatekeeper.additionalExcludedNamespaces
Description
This parameter adds namespaces to Gatekeeper's exemption list, so it will not enforce the constraints on them.
.spec.distribution.modules.policy.gatekeeper.enforcementAction
Description
The enforcement action to use for the gatekeeper module
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"deny" |
"dryrun" |
"warn" |
.spec.distribution.modules.policy.gatekeeper.installDefaultPolicies
Description
If true, the default policies will be installed
.spec.distribution.modules.policy.gatekeeper.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.policy.gatekeeper.overrides.nodeSelector
Description
The node selector to use to place the pods for the gatekeeper module
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the gatekeeper module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.policy.kyverno
Properties
| Property | Type | Required |
|---|---|---|
| additionalExcludedNamespaces | array | Optional |
| validationFailureAction | string | Required |
| installDefaultPolicies | boolean | Required |
| overrides | object | Optional |
.spec.distribution.modules.policy.kyverno.additionalExcludedNamespaces
Description
This parameter adds namespaces to Kyverno's exemption list, so it will not enforce the constraints on them.
.spec.distribution.modules.policy.kyverno.validationFailureAction
Description
The validation failure action to use for the kyverno module
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"audit" |
"enforce" |
.spec.distribution.modules.policy.kyverno.installDefaultPolicies
Description
If true, the default policies will be installed
.spec.distribution.modules.policy.kyverno.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.policy.kyverno.overrides.nodeSelector
Description
The node selector to use to place the pods for the kyverno module
.spec.distribution.modules.policy.kyverno.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the kyverno module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.policy.kyverno.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.policy.kyverno.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.policy.kyverno.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.policy.kyverno.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.tracing
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| type | string | Required |
| tempo | object | Optional |
| minio | object | Optional |
.spec.distribution.modules.tracing.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
| ingresses | object | Optional |
.spec.distribution.modules.tracing.overrides.nodeSelector
Description
The node selector to use to place the pods for the tracing module
.spec.distribution.modules.tracing.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the tracing module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.tracing.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.tracing.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.tracing.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.tracing.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.tracing.overrides.ingresses
Properties
| Property | Type | Required |
|---|---|---|
| host | string | Required |
| ingressClass | string | Required |
.spec.distribution.modules.tracing.overrides.ingresses.host
Description
The host of the ingress
.spec.distribution.modules.tracing.overrides.ingresses.ingressClass
Description
The ingress class of the ingress
.spec.distribution.modules.tracing.type
Description
The type of tracing to use, either none or tempo
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"none" |
"tempo" |
.spec.distribution.modules.tracing.tempo
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| retentionTime | string | Optional |
| backend | string | Optional |
| externalEndpoint | object | Optional |
.spec.distribution.modules.tracing.tempo.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.tracing.tempo.overrides.nodeSelector
Description
The node selector to use to place the pods for the tempo module
.spec.distribution.modules.tracing.tempo.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the tempo module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.tracing.tempo.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.tracing.tempo.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.tracing.tempo.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.tracing.tempo.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.tracing.tempo.retentionTime
Description
The retention time for the tempo pods
.spec.distribution.modules.tracing.tempo.backend
Description
The backend for the tempo pods, must be minio or externalEndpoint
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"minio" |
"externalEndpoint" |
.spec.distribution.modules.tracing.tempo.externalEndpoint
Properties
| Property | Type | Required |
|---|---|---|
| endpoint | string | Required |
| insecure | boolean | Optional |
| secretAccessKey | string | Required |
| accessKeyId | string | Required |
| bucketName | string | Required |
.spec.distribution.modules.tracing.tempo.externalEndpoint.endpoint
Description
The endpoint of the external tempo backend
.spec.distribution.modules.tracing.tempo.externalEndpoint.insecure
Description
If true, the external tempo backend will not use tls
.spec.distribution.modules.tracing.tempo.externalEndpoint.secretAccessKey
Description
The secret access key of the external tempo backend
.spec.distribution.modules.tracing.tempo.externalEndpoint.accessKeyId
Description
The access key id of the external tempo backend
.spec.distribution.modules.tracing.tempo.externalEndpoint.bucketName
Description
The bucket name of the external tempo backend
.spec.distribution.modules.tracing.minio
Properties
| Property | Type | Required |
|---|---|---|
| overrides | object | Optional |
| storageSize | string | Optional |
| rootUser | object | Optional |
.spec.distribution.modules.tracing.minio.overrides
Properties
| Property | Type | Required |
|---|---|---|
| nodeSelector | object | Optional |
| tolerations | array | Optional |
.spec.distribution.modules.tracing.minio.overrides.nodeSelector
Description
The node selector to use to place the pods for the minio module
.spec.distribution.modules.tracing.minio.overrides.tolerations
Properties
| Property | Type | Required |
|---|---|---|
| effect | string | Required |
| operator | string | Optional |
| key | string | Required |
| value | string | Required |
Description
The tolerations that will be added to the pods for the minio module
Constraints
minimum number of items: the minimum number of items for this array is: 0
.spec.distribution.modules.tracing.minio.overrides.tolerations.effect
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"NoSchedule" |
"PreferNoSchedule" |
"NoExecute" |
.spec.distribution.modules.tracing.minio.overrides.tolerations.operator
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"Exists" |
"Equal" |
.spec.distribution.modules.tracing.minio.overrides.tolerations.key
Description
The key of the toleration
.spec.distribution.modules.tracing.minio.overrides.tolerations.value
Description
The value of the toleration
.spec.distribution.modules.tracing.minio.storageSize
Description
The storage size for the minio pods
.spec.distribution.modules.tracing.minio.rootUser
Properties
| Property | Type | Required |
|---|---|---|
| username | string | Required |
| password | string | Required |
.spec.distribution.modules.tracing.minio.rootUser.username
Description
The username for the minio root user
.spec.distribution.modules.tracing.minio.rootUser.password
Description
The password for the minio root user
.spec.distribution.customPatches
Properties
| Property | Type | Required |
|---|---|---|
| configMapGenerator | array | Optional |
| secretGenerator | array | Optional |
| patches | array | Optional |
| patchesStrategicMerge | array | Optional |
| images | array | Optional |
.spec.distribution.customPatches.configMapGenerator
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
| behavior | string | Optional |
| files | array | Optional |
| envs | array | Optional |
| literals | array | Optional |
| namespace | string | Optional |
| options | object | Optional |
.spec.distribution.customPatches.configMapGenerator.name
Description
The name of the configmap
.spec.distribution.customPatches.configMapGenerator.behavior
Description
The behavior of the configmap
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"merge" |
"replace" |
"create" |
.spec.distribution.customPatches.configMapGenerator.files
Description
The files of the configmap
.spec.distribution.customPatches.configMapGenerator.envs
Description
The envs of the configmap
.spec.distribution.customPatches.configMapGenerator.literals
Description
The literals of the configmap
.spec.distribution.customPatches.configMapGenerator.namespace
Description
The namespace of the configmap
.spec.distribution.customPatches.configMapGenerator.options
Properties
| Property | Type | Required |
|---|---|---|
| disableNameSuffixHash | boolean | Optional |
| immutable | boolean | Optional |
| labels | object | Optional |
| annotations | object | Optional |
.spec.distribution.customPatches.configMapGenerator.options.disableNameSuffixHash
Description
If true, the name suffix hash will be disabled
.spec.distribution.customPatches.configMapGenerator.options.immutable
Description
If true, the configmap will be immutable
.spec.distribution.customPatches.configMapGenerator.options.labels
Description
The labels of the configmap
.spec.distribution.customPatches.configMapGenerator.options.annotations
Description
The annotations of the configmap
.spec.distribution.customPatches.secretGenerator
Properties
| Property | Type | Required |
|---|---|---|
| name | string | Required |
| type | string | Optional |
| behavior | string | Optional |
| files | array | Optional |
| envs | array | Optional |
| literals | array | Optional |
| namespace | string | Optional |
| options | object | Optional |
.spec.distribution.customPatches.secretGenerator.name
Description
The name of the secret
.spec.distribution.customPatches.secretGenerator.type
Description
The type of the secret
.spec.distribution.customPatches.secretGenerator.behavior
Description
The behavior of the secret
Constraints
enum: the value of this property must be equal to one of the following values:
| Value |
|---|
"merge" |
"replace" |
"create" |
.spec.distribution.customPatches.secretGenerator.files
Description
The files of the secret
.spec.distribution.customPatches.secretGenerator.envs
Description
The envs of the secret
.spec.distribution.customPatches.secretGenerator.literals
Description
The literals of the secret
.spec.distribution.customPatches.secretGenerator.namespace
Description
The namespace of the secret
.spec.distribution.customPatches.secretGenerator.options
Properties
| Property | Type | Required |
|---|---|---|
| disableNameSuffixHash | boolean | Optional |
| immutable | boolean | Optional |
| labels | object | Optional |
| annotations | object | Optional |
.spec.distribution.customPatches.secretGenerator.options.disableNameSuffixHash
Description
If true, the name suffix hash will be disabled
.spec.distribution.customPatches.secretGenerator.options.immutable
Description
If true, the secret will be immutable
.spec.distribution.customPatches.secretGenerator.options.labels
Description
The labels of the secret
.spec.distribution.customPatches.secretGenerator.options.annotations
Description
The annotations of the secret
.spec.distribution.customPatches.patches
Properties
| Property | Type | Required |
|---|---|---|
| target | object | Optional |
| options | object | Optional |
| path | string | Optional* |
| patch | string | Optional* |
*patch and path cannot be set at the same time*
.spec.distribution.customPatches.patches.target
Properties
| Property | Type | Required |
|---|---|---|
| group | string | Optional |
| version | string | Optional |
| kind | string | Optional |
| name | string | Optional |
| namespace | string | Optional |
| labelSelector | string | Optional |
| annotationSelector | string | Optional |
.spec.distribution.customPatches.patches.target.group
Description
The group of the target
.spec.distribution.customPatches.patches.target.version
Description
The version of the target
.spec.distribution.customPatches.patches.target.kind
Description
The kind of the target
.spec.distribution.customPatches.patches.target.name
Description
The name of the target
.spec.distribution.customPatches.patches.target.namespace
Description
The namespace of the target
.spec.distribution.customPatches.patches.target.labelSelector
Description
The label selector of the target
.spec.distribution.customPatches.patches.target.annotationSelector
Description
The annotation selector of the target
.spec.distribution.customPatches.patches.options
Properties
| Property | Type | Required |
|---|---|---|
| allowNameChange | boolean | Optional |
| allowKindChange | boolean | Optional |
.spec.distribution.customPatches.patches.options.allowNameChange
Description
If true, the name change will be allowed
.spec.distribution.customPatches.patches.options.allowKindChange
Description
If true, the kind change will be allowed
.spec.distribution.customPatches.patches.path
Description
The path of the patch
.spec.distribution.customPatches.patches.patch
Description
The patch
.spec.distribution.customPatches.patchesStrategicMerge
Description
Each entry should be either a relative file path or an inline content resolving to a partial or complete resource definition
.spec.distribution.customPatches.images
Description
Each entry should follow the format of Kustomize's images patch