Version: 1.33.2

KFDDistribution - Distribution Only Cluster Schema

This document explains the full schema for the kind: KFDDistribution for the furyctl.yaml file used by furyctl. This configuration file will be used to deploy the SIGHUP Distribution modules on top of an existing Kubernetes cluster.

An example configuration file can be created by running the following command:

furyctl create config --kind KFDDistribution --version v1.29.4 --name example-cluster

note

Replace the version with your desired version of KFD.

Properties

Property	Type	Required
apiVersion	`string`	Required
flags	`object`	Optional
kind	`string`	Required
metadata	`object`	Required
spec	`object`	Required

Description

SD modules deployed on top of an existing Kubernetes cluster.

.apiVersion

Constraints

pattern: the string must match the following regular expression:

^kfd\.sighup\.io/v\d+((alpha|beta)\d+)?$

try pattern

.flags

Description

Persistent furyctl command flags, see the documentation for more details: https://docs.sighup.io/furyctl/flags-configuration

.kind

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"KFDDistribution"`

.metadata

Properties

Property	Type	Required
name	`string`	Required

.metadata.name

Description

The name of the cluster. It will also be used as a prefix for all the other resources created.

Constraints

maximum length: the maximum number of characters for this string is: 56

minimum length: the minimum number of characters for this string is: 1

.spec

Properties

Property	Type	Required
distribution	`object`	Required
distributionVersion	`string`	Required
plugins	`object`	Optional

.spec.distribution

Properties

Property	Type	Required
common	`object`	Optional
customPatches	`object`	Optional
kubeconfig	`string`	Required
modules	`object`	Required

.spec.distribution.common

Properties

Property	Type	Required
networkPoliciesEnabled	`boolean`	Optional
nodeSelector	`object`	Optional
provider	`object`	Optional
registry	`string`	Optional
relativeVendorPath	`string`	Optional
tolerations	`array`	Optional

Description

Common configuration for all the distribution modules.

.spec.distribution.common.networkPoliciesEnabled

Description

EXPERIMENTAL FEATURE. This field defines whether Network Policies are provided for core modules.

.spec.distribution.common.nodeSelector

Description

The node selector to use to place the pods for all the SD modules. Follows Kubernetes selector format. Example: node.kubernetes.io/role: infra.

.spec.distribution.common.provider

Properties

Property	Type	Required
type	`string`	Required

.spec.distribution.common.provider.type

Description

The provider type. Don't set. FOR INTERNAL USE ONLY.

.spec.distribution.common.registry

Description

URL of the registry where to pull images from for the Distribution phase. (Default is registry.sighup.io/fury).

NOTE: If plugins are pulling from the default registry, the registry will be replaced for the plugin too.

.spec.distribution.common.relativeVendorPath

Description

The relative path to the vendor directory, does not need to be changed.

.spec.distribution.common.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

An array with the tolerations that will be added to the pods for all the SD modules. Follows Kubernetes tolerations format. Example:

- effect: NoSchedule
  key: node.kubernetes.io/role
  value: infra

.spec.distribution.common.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.common.tolerations.key

Description

The key of the toleration

.spec.distribution.common.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.common.tolerations.value

Description

The value of the toleration

.spec.distribution.customPatches

Properties

Property	Type	Required
configMapGenerator	`array`	Optional
images	`array`	Optional
patches	`array`	Optional
patchesStrategicMerge	`array`	Optional
secretGenerator	`array`	Optional

.spec.distribution.customPatches.configMapGenerator

Properties

Property	Type	Required
behavior	`string`	Optional
envs	`array`	Optional
files	`array`	Optional
literals	`array`	Optional
name	`string`	Required
namespace	`string`	Optional
options	`object`	Optional

.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 string values:

Value
`"create"`
`"replace"`
`"merge"`

.spec.distribution.customPatches.configMapGenerator.envs

Description

The envs of the configmap

.spec.distribution.customPatches.configMapGenerator.files

Description

The files of the configmap

.spec.distribution.customPatches.configMapGenerator.literals

Description

The literals of the configmap

.spec.distribution.customPatches.configMapGenerator.name

Description

The name of the configmap

.spec.distribution.customPatches.configMapGenerator.namespace

Description

The namespace of the configmap

.spec.distribution.customPatches.configMapGenerator.options

Properties

Property	Type	Required
annotations	`object`	Optional
disableNameSuffixHash	`boolean`	Optional
immutable	`boolean`	Optional
labels	`object`	Optional

.spec.distribution.customPatches.configMapGenerator.options.annotations

Description

The annotations of the configmap

.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.images

Description

Each entry should follow the format of Kustomize's images patch

.spec.distribution.customPatches.patches

Properties

Property	Type	Required
options	`object`	Optional
patch	`string`	Optional
path	`string`	Optional
target	`object`	Optional

.spec.distribution.customPatches.patches.options

Properties

Property	Type	Required
allowKindChange	`boolean`	Optional
allowNameChange	`boolean`	Optional

.spec.distribution.customPatches.patches.options.allowKindChange

Description

If true, the kind change will be allowed

.spec.distribution.customPatches.patches.options.allowNameChange

Description

If true, the name change will be allowed

.spec.distribution.customPatches.patches.patch

Description

The patch content

.spec.distribution.customPatches.patches.path

Description

The path of the patch

.spec.distribution.customPatches.patches.target

Properties

Property	Type	Required
annotationSelector	`string`	Optional
group	`string`	Optional
kind	`string`	Optional
labelSelector	`string`	Optional
name	`string`	Optional
namespace	`string`	Optional
version	`string`	Optional

.spec.distribution.customPatches.patches.target.annotationSelector

Description

The annotation selector of the target

.spec.distribution.customPatches.patches.target.group

Description

The group of the target

.spec.distribution.customPatches.patches.target.kind

Description

The kind of the target

.spec.distribution.customPatches.patches.target.labelSelector

Description

The label selector 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.version

Description

The version of the target

.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.secretGenerator

Properties

Property	Type	Required
behavior	`string`	Optional
envs	`array`	Optional
files	`array`	Optional
literals	`array`	Optional
name	`string`	Required
namespace	`string`	Optional
options	`object`	Optional
type	`string`	Optional

.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 string values:

Value
`"create"`
`"replace"`
`"merge"`

.spec.distribution.customPatches.secretGenerator.envs

Description

The envs of the secret

.spec.distribution.customPatches.secretGenerator.files

Description

The files of the secret

.spec.distribution.customPatches.secretGenerator.literals

Description

The literals of the secret

.spec.distribution.customPatches.secretGenerator.name

Description

The name of the secret

.spec.distribution.customPatches.secretGenerator.namespace

Description

The namespace of the secret

.spec.distribution.customPatches.secretGenerator.options

Properties

Property	Type	Required
annotations	`object`	Optional
disableNameSuffixHash	`boolean`	Optional
immutable	`boolean`	Optional
labels	`object`	Optional

.spec.distribution.customPatches.secretGenerator.options.annotations

Description

The annotations of the secret

.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.type

Description

The type of the secret

.spec.distribution.kubeconfig

Description

The path to the kubeconfig file.

.spec.distribution.modules

Properties

Property	Type	Required
auth	`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
baseDomain	`string`	Optional
dex	`object`	Optional
oidcTrustedCA	`string`	Optional
overrides	`object`	Optional
pomerium	`object`	Optional
provider	`object`	Required

Description

Configuration for the Auth module.

.spec.distribution.modules.auth.baseDomain

Description

The base domain for the ingresses created by the Auth module (Gangplank, Pomerium, Dex). Notice that when the ingress module type is dual, these will use the external ingress class.

.spec.distribution.modules.auth.dex

Properties

Property	Type	Required
additionalStaticClients	`array`	Optional
connectors	`array`	Required
expiry	`object`	Optional
overrides	`object`	Optional

Description

Configuration for the Dex package.

.spec.distribution.modules.auth.dex.additionalStaticClients

Description

Additional static clients defitions that will be added to the default clients included with the distribution in Dex's configuration. Example:

additionalStaticClients:
  - id: my-custom-client
    name: "A custom additional static client"
    redirectURIs:
      - "https://myapp.tld/redirect"
      - "https://alias.tld/oidc-callback"
    secret: supersecretpassword

Reference: https://dexidp.io/docs/connectors/local/

.spec.distribution.modules.auth.dex.connectors

Description

A list with each item defining a Dex connector. Follows Dex connectors configuration format: https://dexidp.io/docs/connectors/

.spec.distribution.modules.auth.dex.expiry

Properties

Property	Type	Required
idTokens	`string`	Optional
signingKeys	`string`	Optional

.spec.distribution.modules.auth.dex.expiry.idTokens

Description

Dex ID tokens expiration time duration (default 24h).

.spec.distribution.modules.auth.dex.expiry.signingKeys

Description

Dex signing key expiration time duration (default 6h).

.spec.distribution.modules.auth.dex.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.auth.dex.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.auth.dex.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.auth.dex.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.auth.dex.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.auth.dex.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.auth.dex.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.auth.oidcTrustedCA

Description

The Certificate Authority certificate file's content to trust for self-signed certificates at the OAuth2 URL. You can use the "{file://<path>}" notation to get the content from a file.

.spec.distribution.modules.auth.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the Auth module.

.spec.distribution.modules.auth.overrides.ingresses

Description

Override the definition of the Auth module ingresses.

.spec.distribution.modules.auth.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the Auth module.

.spec.distribution.modules.auth.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the Auth module.

.spec.distribution.modules.auth.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.auth.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.auth.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.auth.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.auth.pomerium

Properties

Property	Type	Required
defaultRoutesPolicy	`object`	Optional
overrides	`object`	Optional
policy	`string`	Optional
routes	`array`	Optional
secrets	`object`	Required

Description

Configuration for Pomerium, an identity-aware reverse proxy used for SSO.

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy

Properties

Property	Type	Required
gatekeeperPolicyManager	`array`	Optional
hubbleUi	`array`	Optional
ingressForecastle	`array`	Optional
loggingMinioConsole	`array`	Optional
loggingOpensearchDashboards	`array`	Optional
monitoringAlertmanager	`array`	Optional
monitoringGrafana	`array`	Optional
monitoringMinioConsole	`array`	Optional
monitoringPrometheus	`array`	Optional
tracingMinioConsole	`array`	Optional

Description

override default routes for SD components

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.gatekeeperPolicyManager

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.hubbleUi

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.ingressForecastle

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.loggingMinioConsole

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.loggingOpensearchDashboards

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringAlertmanager

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringGrafana

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringMinioConsole

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringPrometheus

.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.tracingMinioConsole

.spec.distribution.modules.auth.pomerium.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.auth.pomerium.overrides.nodeSelector

.spec.distribution.modules.auth.pomerium.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Required

.spec.distribution.modules.auth.pomerium.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.auth.pomerium.overrides.tolerations.key

.spec.distribution.modules.auth.pomerium.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.auth.pomerium.overrides.tolerations.value

.spec.distribution.modules.auth.pomerium.policy

Description

DEPRECATED: Use defaultRoutesPolicy and/or routes

.spec.distribution.modules.auth.pomerium.routes

Description

Additional routes configuration for Pomerium. Follows Pomerium's route format: https://www.pomerium.com/docs/reference/routes

.spec.distribution.modules.auth.pomerium.secrets

Properties

Property	Type	Required
COOKIE_SECRET	`string`	Required
IDP_CLIENT_SECRET	`string`	Required
SHARED_SECRET	`string`	Required
SIGNING_KEY	`string`	Required

Description

Pomerium needs some user-provided secrets to be fully configured. These secrets should be unique between clusters.

.spec.distribution.modules.auth.pomerium.secrets.COOKIE_SECRET

Description

Cookie Secret is the secret used to encrypt and sign session cookies.

To generate a random key, run the following command: head -c32 /dev/urandom | base64

.spec.distribution.modules.auth.pomerium.secrets.IDP_CLIENT_SECRET

Description

Identity Provider Client Secret is the OAuth 2.0 Secret Identifier. When auth type is SSO, this value will be the secret used to authenticate Pomerium with Dex, use a strong random value.

.spec.distribution.modules.auth.pomerium.secrets.SHARED_SECRET

Description

Shared Secret is the base64-encoded, 256-bit key used to mutually authenticate requests between Pomerium services. It's critical that secret keys are random, and stored safely.

To generate a key, run the following command: head -c32 /dev/urandom | base64

.spec.distribution.modules.auth.pomerium.secrets.SIGNING_KEY

Description

Signing Key is the base64 representation of one or more PEM-encoded private keys used to sign a user's attestation JWT, which can be consumed by upstream applications to pass along identifying user information like username, id, and groups.

To generates an P-256 (ES256) signing key:

openssl ecparam -genkey -name prime256v1 -noout -out ec_private.pem
# careful! this will output your private key in terminal
cat ec_private.pem | base64

.spec.distribution.modules.auth.provider

Properties

Property	Type	Required
basicAuth	`object`	Optional
type	`string`	Required

.spec.distribution.modules.auth.provider.basicAuth

Properties

Property	Type	Required
password	`string`	Required
username	`string`	Required

Description

Configuration for the HTTP Basic Auth provider.

.spec.distribution.modules.auth.provider.basicAuth.password

Description

The password for logging in with the HTTP basic authentication.

.spec.distribution.modules.auth.provider.basicAuth.username

Description

The username for logging in with the HTTP basic authentication.

.spec.distribution.modules.auth.provider.type

Description

The type of the Auth provider, options are:

none: will disable authentication in the infrastructural ingresses.
sso: will protect the infrastructural ingresses with Pomerium and Dex (SSO) and require authentication before accessing them.
basicAuth: will protect the infrastructural ingresses with HTTP basic auth (username and password) authentication.

Default is none.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"basicAuth"`
`"sso"`

.spec.distribution.modules.dr

Properties

Property	Type	Required
overrides	`object`	Optional
type	`string`	Required
velero	`object`	Optional

Description

Configuration for the Disaster Recovery module.

.spec.distribution.modules.dr.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the module.

.spec.distribution.modules.dr.overrides.ingresses

.spec.distribution.modules.dr.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the module.

.spec.distribution.modules.dr.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the module.

.spec.distribution.modules.dr.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.dr.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.dr.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.dr.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.dr.type

Description

The type of the Disaster Recovery, must be none or on-premises. none disables the module and on-premises will install Velero and an optional MinIO deployment.

Default is none.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"on-premises"`

.spec.distribution.modules.dr.velero

Properties

Property	Type	Required
backend	`string`	Optional
externalEndpoint	`object`	Optional
gcs	`object`	Optional
nodeAgent	`object`	Optional
overrides	`object`	Optional
schedules	`object`	Optional
snapshotController	`object`	Optional

Description

Configuration for the Velero package.

.spec.distribution.modules.dr.velero.backend

Description

The storage backend type for Velero. minio will use an in-cluster MinIO deployment for object storage, externalEndpoint can be used to point to an external S3-compatible object storage instead of deploying an in-cluster MinIO, gcs can be used to point to gcs object storage instead of deploying an in-cluster MinIO.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"minio"`
`"externalEndpoint"`
`"gcs"`

.spec.distribution.modules.dr.velero.externalEndpoint

Properties

Property	Type	Required
accessKeyId	`string`	Optional
accessMode	`string`	Optional
bucketName	`string`	Optional
endpoint	`string`	Optional
insecure	`boolean`	Optional
prefixName	`string`	Optional
secretAccessKey	`string`	Optional

Description

Configuration for Velero's external storage backend.

.spec.distribution.modules.dr.velero.externalEndpoint.accessKeyId

Description

The access key ID (username) for the external S3-compatible bucket.

.spec.distribution.modules.dr.velero.externalEndpoint.accessMode

Description

How Velero can access the backup storage location.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"ReadWrite"`
`"ReadOnly"`

.spec.distribution.modules.dr.velero.externalEndpoint.bucketName

Description

The bucket name of the external object storage.

.spec.distribution.modules.dr.velero.externalEndpoint.endpoint

Description

External S3-compatible endpoint for Velero's storage.

.spec.distribution.modules.dr.velero.externalEndpoint.insecure

Description

If true, will use HTTP as protocol instead of HTTPS.

.spec.distribution.modules.dr.velero.externalEndpoint.prefixName

Description

The prefix name to use inside the bucket.

.spec.distribution.modules.dr.velero.externalEndpoint.secretAccessKey

Description

The secret access key (password) for the external S3-compatible bucket.

.spec.distribution.modules.dr.velero.gcs

Properties

Property	Type	Required
accessMode	`string`	Optional
bucketName	`string`	Optional
clientEmail	`string`	Optional
prefixName	`string`	Optional
serviceAccountString	`string`	Optional

Description

Configuration for Velero's gcs storage backend.

.spec.distribution.modules.dr.velero.gcs.accessMode

Description

How Velero can access the backup storage location.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"ReadWrite"`
`"ReadOnly"`

.spec.distribution.modules.dr.velero.gcs.bucketName

Description

The bucket name of the gcs object storage.

.spec.distribution.modules.dr.velero.gcs.clientEmail

Description

Full gcs client email.

.spec.distribution.modules.dr.velero.gcs.prefixName

Description

The prefix name to use inside the gcs bucket.

.spec.distribution.modules.dr.velero.gcs.serviceAccountString

Description

Service gcs account JSON string.

.spec.distribution.modules.dr.velero.nodeAgent

Properties

Property	Type	Required
prepareQueueLength	`integer`	Optional

Description

Configuration for Velero's node-agent DaemonSet.

.spec.distribution.modules.dr.velero.nodeAgent.prepareQueueLength

Description

Defines the maximum number of DataUpload/DataDownload/PodVolumeBackup/PodVolumeRestore CRs under preparation statuses but not yet processed by any node. This constrains the number of intermediate objects (PVCs, VolumeSnapshots, etc.) to prevent unnecessary resource usage when cluster parallelism is limited.

.spec.distribution.modules.dr.velero.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.dr.velero.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.dr.velero.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.dr.velero.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.dr.velero.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.dr.velero.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.dr.velero.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.dr.velero.schedules

Properties

Property	Type	Required
definitions	`object`	Optional
install	`boolean`	Optional

Description

Configuration for Velero's backup schedules.

.spec.distribution.modules.dr.velero.schedules.definitions

Properties

Property	Type	Required
full	`object`	Optional
manifests	`object`	Optional

Description

Configuration for Velero schedules.

.spec.distribution.modules.dr.velero.schedules.definitions.full

Properties

Property	Type	Required
schedule	`string`	Optional
snapshotMoveData	`boolean`	Optional
ttl	`string`	Optional

Description

Configuration for Velero's manifests backup schedule.

.spec.distribution.modules.dr.velero.schedules.definitions.full.schedule

Description

The cron expression for the full backup schedule (default 0 1 * * *).

.spec.distribution.modules.dr.velero.schedules.definitions.full.snapshotMoveData

Description

EXPERIMENTAL (if you do more than one backups, the following backups after the first are not automatically restorable, see https://github.com/vmware-tanzu/velero/issues/7057#issuecomment-2466815898 for the manual restore solution): SnapshotMoveData specifies whether snapshot data should be moved. Velero will create a new volume from the snapshot and upload the content to the storageLocation.

.spec.distribution.modules.dr.velero.schedules.definitions.full.ttl

Description

The Time To Live (TTL) of the backups created by the backup schedules (default 720h0m0s, 30 days). Notice that changing this value will affect only newly created backups, prior backups will keep the old TTL.

.spec.distribution.modules.dr.velero.schedules.definitions.manifests

Properties

Property	Type	Required
schedule	`string`	Optional
ttl	`string`	Optional

Description

Configuration for Velero's manifests backup schedule.

.spec.distribution.modules.dr.velero.schedules.definitions.manifests.schedule

Description

The cron expression for the manifests backup schedule (default */15 * * * *).

.spec.distribution.modules.dr.velero.schedules.definitions.manifests.ttl

Description

.spec.distribution.modules.dr.velero.schedules.install

Description

Whether to install or not the default manifests and full backups schedules. Default is true.

.spec.distribution.modules.dr.velero.snapshotController

Properties

Property	Type	Required
install	`boolean`	Optional

Description

Configuration for the additional snapshotController component installation.

.spec.distribution.modules.dr.velero.snapshotController.install

Description

Whether to install or not the snapshotController component in the cluster. Before enabling this field, check if your CSI driver does not have snapshotController built-in.

.spec.distribution.modules.ingress

Properties

Property	Type	Required
baseDomain	`string`	Required
byoic	`object`	Optional
certManager	`object`	Optional
forecastle	`object`	Optional
haproxy	`object`	Optional
infrastructureIngressController	`string`	Optional
nginx	`object`	Required
overrides	`object`	Optional

.spec.distribution.modules.ingress.baseDomain

Description

The base domain used for all the SD infrastructural ingresses. If using the nginx dual type, this value should be the same as the domain associated with the internal ingress class.

.spec.distribution.modules.ingress.byoic

Properties

Property	Type	Required
commonAnnotations	`object`	Optional
enabled	`boolean`	Required
ingressClass	`string`	Optional

Description

Configuration for Bring Your Own Ingress Controller mode. The ingressClass is used for infrastructure ingresses when both controllers are disabled.

.spec.distribution.modules.ingress.byoic.commonAnnotations

Description

Annotations to apply to all infrastructure ingresses when using this BYOIC ingress class. Useful for controller-specific configuration (TLS, auth middlewares, etc.).

.spec.distribution.modules.ingress.byoic.enabled

Description

Enable BYOIC mode.

.spec.distribution.modules.ingress.byoic.ingressClass

Description

The IngressClass to use for infrastructure ingresses (Prometheus, Grafana, etc.) when both nginx and haproxy are disabled.

.spec.distribution.modules.ingress.certManager

Properties

Property	Type	Required
clusterIssuer	`object`	Required
overrides	`object`	Optional

Description

Configuration for the cert-manager package. Required even if ingress.nginx.type is none, cert-manager is used for managing other certificates in the cluster besides the TLS termination certificates for the ingresses.

.spec.distribution.modules.ingress.certManager.clusterIssuer

Properties

Property	Type	Required
email	`string`	Required
name	`string`	Required
solvers	`array`	Optional
type	`string`	Optional

Description

Configuration for the cert-manager's ACME clusterIssuer used to request certificates from Let's Encrypt.

.spec.distribution.modules.ingress.certManager.clusterIssuer.email

Description

The email address to use during the certificate issuing process.

.spec.distribution.modules.ingress.certManager.clusterIssuer.name

Description

The name of the clusterIssuer.

.spec.distribution.modules.ingress.certManager.clusterIssuer.solvers

Description

The list of challenge solvers to use instead of the default one for the http01 challenge. Check cert manager's documentation for examples for this field.

.spec.distribution.modules.ingress.certManager.clusterIssuer.type

Description

The type of the clusterIssuer. Only http01 challenge is supported for KFDDistribution kind. See solvers for arbitrary configurations.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"http01"`

.spec.distribution.modules.ingress.certManager.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.ingress.certManager.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.ingress.certManager.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.ingress.certManager.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.ingress.certManager.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.ingress.certManager.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.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

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.ingress.forecastle.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.ingress.forecastle.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.ingress.forecastle.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.ingress.forecastle.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.ingress.forecastle.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.ingress.haproxy

Properties

Property	Type	Required
overrides	`object`	Optional
tls	`object`	Optional
type	`string`	Required

Description

Configuration for HAProxy Kubernetes Ingress Controller.

.spec.distribution.modules.ingress.haproxy.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.ingress.haproxy.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.ingress.haproxy.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.ingress.haproxy.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.ingress.haproxy.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.ingress.haproxy.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.ingress.haproxy.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.ingress.haproxy.tls

Properties

Property	Type	Required
provider	`string`	Required
secret	`object`	Optional

Description

TLS configuration for the HAProxy ingress controller.

.spec.distribution.modules.ingress.haproxy.tls.provider

Description

The provider of the TLS certificates for the ingresses, one of: none, certManager, or secret.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"certManager"`
`"secret"`
`"none"`

.spec.distribution.modules.ingress.haproxy.tls.secret

Properties

Property	Type	Required
ca	`string`	Required
cert	`string`	Required
key	`string`	Required

Description

Kubernetes TLS secret for the HAProxy ingresses TLS certificate.

.spec.distribution.modules.ingress.haproxy.tls.secret.ca

Description

The Certificate Authority certificate file's content. You can use the "{file://<path>}" notation to get the content from a file.

.spec.distribution.modules.ingress.haproxy.tls.secret.cert

Description

The certificate file's content. You can use the "{file://<path>}" notation to get the content from a file.

.spec.distribution.modules.ingress.haproxy.tls.secret.key

Description

The signing key file's content. You can use the "{file://<path>}" notation to get the content from a file.

.spec.distribution.modules.ingress.haproxy.type

Description

The type of the HAProxy ingress controller, options are:

none: HAProxy ingress controller will not be installed.
single: a single HAProxy ingress controller with ingress class haproxy will be installed.
dual: two independent HAProxy ingress controllers will be installed, one for the haproxy-internal ingress class and one for the haproxy-external ingress class.

Default is none.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"single"`
`"dual"`

.spec.distribution.modules.ingress.infrastructureIngressController

Description

Overrides the default ingress controller for SD infrastructure ingresses. Set to nginx or haproxy to select the controller family; the dual/single class mapping (e.g., haproxy-internal/haproxy-external) is applied automatically based on the controller's type setting. Useful during migrations to keep infrastructure ingresses on one controller while testing another. Do not use this field when both nginx.type and haproxy.type are none: in that case rely on byoic.ingressClass to define the ingress class for SD ingresses.

.spec.distribution.modules.ingress.nginx

Properties

Property	Type	Required
overrides	`object`	Optional
tls	`object`	Optional
type	`string`	Required

Description

Configurations for the Ingress nginx controller package.

.spec.distribution.modules.ingress.nginx.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.ingress.nginx.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.ingress.nginx.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.ingress.nginx.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.ingress.nginx.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.ingress.nginx.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.ingress.nginx.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.ingress.nginx.tls

Properties

Property	Type	Required
provider	`string`	Required
secret	`object`	Optional

Description

TLS configuration for the nginx ingress controller.

.spec.distribution.modules.ingress.nginx.tls.provider

Description

The provider of the TLS certificates for the ingresses, one of: none, certManager, or secret.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"certManager"`
`"secret"`
`"none"`

.spec.distribution.modules.ingress.nginx.tls.secret

Properties

Property	Type	Required
ca	`string`	Required
cert	`string`	Required
key	`string`	Required

Description

Kubernetes TLS secret for the ingresses TLS certificate.

.spec.distribution.modules.ingress.nginx.tls.secret.ca

Description

The Certificate Authority certificate file's content. You can use the "{file://<path>}" notation to get the content from a file.

.spec.distribution.modules.ingress.nginx.tls.secret.cert

Description

The certificate file's content. You can use the "{file://<path>}" notation to get the content from a file.

.spec.distribution.modules.ingress.nginx.tls.secret.key

Description

The signing key file's content. You can use the "{file://<path>}" notation to get the content from a file.

.spec.distribution.modules.ingress.nginx.type

Description

The type of the Ingress nginx controller, options are:

none: no ingress controller will be installed and no infrastructural ingresses will be created.
single: a single ingress controller with ingress class nginx will be installed to manage all the ingress resources, infrastructural ingresses will be created.
dual: two independent ingress controllers will be installed, one for the internal ingress class intended for private ingresses and one for the external ingress class intended for public ingresses. SD infrastructural ingresses wil use the internal ingress class when using the dual type.

Default is single.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"single"`
`"dual"`

.spec.distribution.modules.ingress.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the Ingress module.

.spec.distribution.modules.ingress.overrides.ingresses

Properties

Property	Type	Required
forecastle	`object`	Optional

.spec.distribution.modules.ingress.overrides.ingresses.forecastle

Properties

Property	Type	Required
disableAuth	`boolean`	Optional
host	`string`	Optional
ingressClass	`string`	Optional

.spec.distribution.modules.ingress.overrides.ingresses.forecastle.disableAuth

Description

If true, the ingress will not have authentication even if .spec.modules.auth.provider.type is SSO or Basic Auth.

.spec.distribution.modules.ingress.overrides.ingresses.forecastle.host

Description

Use this host for the ingress instead of the default one.

.spec.distribution.modules.ingress.overrides.ingresses.forecastle.ingressClass

Description

Use this ingress class for the ingress instead of the default one.

.spec.distribution.modules.ingress.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the Ingress module.

.spec.distribution.modules.ingress.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the Ingress module.

.spec.distribution.modules.ingress.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.ingress.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.ingress.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.ingress.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.logging

Properties

Property	Type	Required
cerebro	`object`	Optional
customOutputs	`object`	Optional
loki	`object`	Optional
minio	`object`	Optional
opensearch	`object`	Optional
operator	`object`	Optional
overrides	`object`	Optional
type	`string`	Required

Description

Configuration for the Logging module.

.spec.distribution.modules.logging.cerebro

Properties

Property	Type	Required
overrides	`object`	Optional

Description

DEPRECATED since KFD v1.26.6, 1.27.5, v1.28.0.

.spec.distribution.modules.logging.cerebro.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.logging.cerebro.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.logging.cerebro.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.logging.cerebro.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.logging.cerebro.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.logging.cerebro.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.logging.cerebro.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.logging.customOutputs

Properties

Property	Type	Required
audit	`string`	Required
errors	`string`	Required
events	`string`	Required
infra	`string`	Required
ingressHaproxy	`string`	Required
ingressNginx	`string`	Required
kubernetes	`string`	Required
systemdCommon	`string`	Required
systemdEtcd	`string`	Required

Description

When using the customOutputs logging type, you need to manually specify the spec of the several Output and ClusterOutputs that the Logging Operator expects to forward the logs collected by the pre-defined flows.

.spec.distribution.modules.logging.customOutputs.audit

Description

This value defines where the output from the audit Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.errors

Description

This value defines where the output from the errors Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.events

Description

This value defines where the output from the events Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.infra

Description

This value defines where the output from the infra Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.ingressHaproxy

Description

This value defines where the output from the ingressHaproxy Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.ingressNginx

Description

This value defines where the output from the ingressNginx Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.kubernetes

Description

This value defines where the output from the kubernetes Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.systemdCommon

Description

This value defines where the output from the systemdCommon Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.customOutputs.systemdEtcd

Description

This value defines where the output from the systemdEtcd Flow will be sent. This will be the spec section of the Output object. It must be a string (and not a YAML object) following the OutputSpec definition. Use the nullout output to discard the flow: nullout: {}

.spec.distribution.modules.logging.loki

Properties

Property	Type	Required
backend	`string`	Optional
externalEndpoint	`object`	Optional
resources	`object`	Optional
retentionTime	`string`	Optional
tsdbStartDate	`string`	Optional

Description

Configuration for the Loki package.

.spec.distribution.modules.logging.loki.backend

Description

The storage backend type for Loki. minio will use an in-cluster MinIO deployment for object storage, externalEndpoint can be used to point to an external object storage instead of deploying an in-cluster MinIO.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"minio"`
`"externalEndpoint"`

.spec.distribution.modules.logging.loki.externalEndpoint

Properties

Property	Type	Required
accessKeyId	`string`	Optional
bucketName	`string`	Optional
endpoint	`string`	Optional
insecure	`boolean`	Optional
secretAccessKey	`string`	Optional

Description

Configuration for Loki's external storage backend.

.spec.distribution.modules.logging.loki.externalEndpoint.accessKeyId

Description

The access key ID (username) for the external S3-compatible bucket.

.spec.distribution.modules.logging.loki.externalEndpoint.bucketName

Description

The bucket name of the external S3-compatible object storage.

.spec.distribution.modules.logging.loki.externalEndpoint.endpoint

Description

External S3-compatible endpoint for Loki's storage.

.spec.distribution.modules.logging.loki.externalEndpoint.insecure

Description

If true, will use HTTP as protocol instead of HTTPS.

.spec.distribution.modules.logging.loki.externalEndpoint.secretAccessKey

Description

The secret access key (password) for the external S3-compatible bucket.

.spec.distribution.modules.logging.loki.resources

Properties

Property	Type	Required
limits	`object`	Optional
requests	`object`	Optional

.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 Pod. Example: 1000m.

.spec.distribution.modules.logging.loki.resources.limits.memory

Description

The memory limit for the Pod. Example: 1G.

.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 Pod, in cores. Example: 500m.

.spec.distribution.modules.logging.loki.resources.requests.memory

Description

The memory request for the Pod. Example: 500M.

.spec.distribution.modules.logging.loki.retentionTime

Description

Optional retention period for logs stored in Loki (default 720h, 30 days). Setting it to 0s disables retention. Format must match: [0-9]+(s|m|h|d|w|y).

.spec.distribution.modules.logging.loki.tsdbStartDate

Description

Starting from versions 1.28.4, 1.29.5 and 1.30.0 of SIGHUP Distribution, Loki changed the time series database from BoltDB to TSDB and the schema that it uses to store the logs from v11 to v13.

The value of this field will determine the date when Loki will start writing using the new TSDB and the schema v13, always at midnight UTC. The old BoltDB and schema will be kept until all the logs expire for reading purposes.

From versions 1.29.7, 1.30.2 and 1.31.1 of the Distribution, this field will be immutable once set and its value should be a date before upgrading to one of these versions or creating the cluster, Loki does not support writing BoltDB and schema v11 anymore.

Value must be a string in ISO 8601 date format (yyyy-mm-dd). Example: 2024-11-18.

.spec.distribution.modules.logging.minio

Properties

Property	Type	Required
overrides	`object`	Optional
rootUser	`object`	Optional
storageSize	`string`	Optional

Description

Configuration for Logging's MinIO deployment.

.spec.distribution.modules.logging.minio.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.logging.minio.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.logging.minio.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.logging.minio.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.logging.minio.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.logging.minio.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.logging.minio.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.logging.minio.rootUser

Properties

Property	Type	Required
password	`string`	Optional
username	`string`	Optional

.spec.distribution.modules.logging.minio.rootUser.password

Description

The password for the default MinIO root user.

.spec.distribution.modules.logging.minio.rootUser.username

Description

The username for the default MinIO root user.

.spec.distribution.modules.logging.minio.storageSize

Description

The PVC size for each MinIO disk, 6 disks total.

.spec.distribution.modules.logging.opensearch

Properties

Property	Type	Required
overrides	`object`	Optional
resources	`object`	Optional
storageSize	`string`	Optional
type	`string`	Required

.spec.distribution.modules.logging.opensearch.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.logging.opensearch.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.logging.opensearch.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.logging.opensearch.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.logging.opensearch.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.logging.opensearch.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.logging.opensearch.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.logging.opensearch.resources

Properties

Property	Type	Required
limits	`object`	Optional
requests	`object`	Optional

.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 Pod. Example: 1000m.

.spec.distribution.modules.logging.opensearch.resources.limits.memory

Description

The memory limit for the Pod. Example: 1G.

.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 Pod, in cores. Example: 500m.

.spec.distribution.modules.logging.opensearch.resources.requests.memory

Description

The memory request for the Pod. Example: 500M.

.spec.distribution.modules.logging.opensearch.storageSize

Description

The storage size for the OpenSearch volumes. Follows Kubernetes resources storage requests. Default is 150Gi.

.spec.distribution.modules.logging.opensearch.type

Description

The type of OpenSearch deployment. One of: single for a single replica or triple for an HA 3-replicas deployment.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"single"`
`"triple"`

.spec.distribution.modules.logging.operator

Properties

Property	Type	Required
overrides	`object`	Optional

Description

Configuration for the Logging Operator.

.spec.distribution.modules.logging.operator.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.logging.operator.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.logging.operator.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.logging.operator.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.logging.operator.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.logging.operator.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.logging.operator.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.logging.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the module.

.spec.distribution.modules.logging.overrides.ingresses

.spec.distribution.modules.logging.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the module.

.spec.distribution.modules.logging.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the module.

.spec.distribution.modules.logging.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.logging.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.logging.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.logging.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.logging.type

Description

Selects the logging stack. Options are:

none: will disable the centralized logging.
opensearch: will deploy and configure the Logging Operator and an OpenSearch cluster (can be single or triple for HA) where the logs will be stored.
loki: will use a distributed Grafana Loki instead of OpenSearch for storage.
customOuputs: the Logging Operator will be deployed and installed but without in-cluster storage, you will have to create the needed Outputs and ClusterOutputs to ship the logs to your desired storage.

Default is opensearch.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"opensearch"`
`"loki"`
`"customOutputs"`

.spec.distribution.modules.monitoring

Properties

Property	Type	Required
alertmanager	`object`	Optional
blackboxExporter	`object`	Optional
grafana	`object`	Optional
kubeStateMetrics	`object`	Optional
mimir	`object`	Optional
minio	`object`	Optional
overrides	`object`	Optional
prometheus	`object`	Optional
prometheusAdapter	`object`	Optional
prometheusAgent	`object`	Optional
type	`string`	Required
x509Exporter	`object`	Optional

Description

Configuration for the Monitoring module.

.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 dead man's switch monitoring, for example to use with healthchecks.io.

.spec.distribution.modules.monitoring.alertmanager.installDefaultRules

Description

Set to false to avoid installing the Prometheus rules (alerts) included with the distribution.

.spec.distribution.modules.monitoring.alertmanager.slackWebhookUrl

Description

The Slack webhook URL where to send the infrastructural and workload alerts to.

.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

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.monitoring.grafana

Properties

Property	Type	Required
basicAuthIngress	`boolean`	Optional
overrides	`object`	Optional
usersRoleAttributePath	`string`	Optional

.spec.distribution.modules.monitoring.grafana.basicAuthIngress

Description

Setting this to true will deploy an additional grafana-basic-auth ingress protected with Grafana's basic auth instead of SSO. It's intended use is as a temporary ingress for when there are problems with the SSO login flow.

Notice that by default anonymous access is enabled.

.spec.distribution.modules.monitoring.grafana.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.monitoring.grafana.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.monitoring.grafana.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.monitoring.grafana.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.monitoring.grafana.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.monitoring.grafana.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.monitoring.grafana.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.monitoring.grafana.usersRoleAttributePath

Description

JMESPath expression to retrieve the user's role. Example:

usersRoleAttributePath: "contains(groups[*], 'beta') && 'Admin' || contains(groups[*], 'gamma') && 'Editor' || contains(groups[*], 'delta') && 'Viewer'

More details in Grafana's documentation.

.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

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.monitoring.mimir

Properties

Property	Type	Required
backend	`string`	Optional
externalEndpoint	`object`	Optional
overrides	`object`	Optional
retentionTime	`string`	Optional

Description

Configuration for the Mimir package.

.spec.distribution.modules.monitoring.mimir.backend

Description

The storage backend type for Mimir. minio will use an in-cluster MinIO deployment for object storage, externalEndpoint can be used to point to an external S3-compatible object storage instead of deploying an in-cluster MinIO.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"minio"`
`"externalEndpoint"`

.spec.distribution.modules.monitoring.mimir.externalEndpoint

Properties

Property	Type	Required
accessKeyId	`string`	Optional
bucketName	`string`	Optional
endpoint	`string`	Optional
insecure	`boolean`	Optional
secretAccessKey	`string`	Optional

Description

Configuration for Mimir's external storage backend.

.spec.distribution.modules.monitoring.mimir.externalEndpoint.accessKeyId

Description

The access key ID (username) for the external S3-compatible bucket.

.spec.distribution.modules.monitoring.mimir.externalEndpoint.bucketName

Description

The bucket name of the external S3-compatible object storage.

.spec.distribution.modules.monitoring.mimir.externalEndpoint.endpoint

Description

The external S3-compatible endpoint for Mimir's storage.

.spec.distribution.modules.monitoring.mimir.externalEndpoint.insecure

Description

If true, will use HTTP as protocol instead of HTTPS.

.spec.distribution.modules.monitoring.mimir.externalEndpoint.secretAccessKey

Description

The secret access key (password) for the external S3-compatible bucket.

.spec.distribution.modules.monitoring.mimir.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.monitoring.mimir.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.monitoring.mimir.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.monitoring.mimir.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.monitoring.mimir.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.monitoring.mimir.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.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 logs stored in Mimir. Default is 30d. Value must match the regular expression [0-9]+(ns|us|µs|ms|s|m|h|d|w|y) where y = 365 days.

.spec.distribution.modules.monitoring.minio

Properties

Property	Type	Required
overrides	`object`	Optional
rootUser	`object`	Optional
storageSize	`string`	Optional

Description

Configuration for Monitoring's MinIO deployment.

.spec.distribution.modules.monitoring.minio.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.monitoring.minio.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.monitoring.minio.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.monitoring.minio.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.monitoring.minio.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.monitoring.minio.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.monitoring.minio.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.monitoring.minio.rootUser

Properties

Property	Type	Required
password	`string`	Optional
username	`string`	Optional

.spec.distribution.modules.monitoring.minio.rootUser.password

Description

The password for the default MinIO root user.

.spec.distribution.modules.monitoring.minio.rootUser.username

Description

The username for the default MinIO root user.

.spec.distribution.modules.monitoring.minio.storageSize

Description

The PVC size for each MinIO disk, 6 disks total.

.spec.distribution.modules.monitoring.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the module.

.spec.distribution.modules.monitoring.overrides.ingresses

.spec.distribution.modules.monitoring.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the module.

.spec.distribution.modules.monitoring.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the module.

.spec.distribution.modules.monitoring.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.monitoring.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.monitoring.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.monitoring.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.monitoring.prometheus

Properties

Property	Type	Required
remoteWrite	`array`	Optional
resources	`object`	Optional
retentionSize	`string`	Optional
retentionTime	`string`	Optional
storageSize	`string`	Optional

.spec.distribution.modules.monitoring.prometheus.remoteWrite

Description

Set this option to ship the collected metrics to a remote Prometheus receiver.

remoteWrite is an array of objects that allows configuring the remoteWrite options for Prometheus. The objects in the array follow the same schema as in the prometheus operator.

.spec.distribution.modules.monitoring.prometheus.resources

Properties

Property	Type	Required
limits	`object`	Optional
requests	`object`	Optional

.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 Pod. Example: 1000m.

.spec.distribution.modules.monitoring.prometheus.resources.limits.memory

Description

The memory limit for the Pod. Example: 1G.

.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 Pod, in cores. Example: 500m.

.spec.distribution.modules.monitoring.prometheus.resources.requests.memory

Description

The memory request for the Pod. Example: 500M.

.spec.distribution.modules.monitoring.prometheus.retentionSize

Description

The retention size for the k8s Prometheus instance.

.spec.distribution.modules.monitoring.prometheus.retentionTime

Description

The retention time for the k8s Prometheus instance.

.spec.distribution.modules.monitoring.prometheus.storageSize

Description

The storage size for the k8s Prometheus instance.

.spec.distribution.modules.monitoring.prometheusAdapter

Properties

Property	Type	Required
installEnhancedHPAMetrics	`boolean`	Optional
resources	`object`	Optional

.spec.distribution.modules.monitoring.prometheusAdapter.installEnhancedHPAMetrics

Description

Configures whether to enable advanced HPA metric collection in the Prometheus Adapter. When set to true, the Prometheus Adapter component will query Prometheus instances directly to retrieve additional metrics related to the Horizontal Pod Autoscaler (HPA). These metrics provide deeper visibility into HPA behaviour and performance. Caution: Enabling this feature results in a significant increase in RAM consumption of the Prometheus Adapter, as it requires managing an additional dataset. Default value: true.

.spec.distribution.modules.monitoring.prometheusAdapter.resources

Properties

Property	Type	Required
limits	`object`	Optional
requests	`object`	Optional

.spec.distribution.modules.monitoring.prometheusAdapter.resources.limits

Properties

Property	Type	Required
cpu	`string`	Optional
memory	`string`	Optional

.spec.distribution.modules.monitoring.prometheusAdapter.resources.limits.cpu

Description

The CPU limit for the Pod. Example: 1000m.

.spec.distribution.modules.monitoring.prometheusAdapter.resources.limits.memory

Description

The memory limit for the Pod. Example: 1G.

.spec.distribution.modules.monitoring.prometheusAdapter.resources.requests

Properties

Property	Type	Required
cpu	`string`	Optional
memory	`string`	Optional

.spec.distribution.modules.monitoring.prometheusAdapter.resources.requests.cpu

Description

The CPU request for the Pod, in cores. Example: 500m.

.spec.distribution.modules.monitoring.prometheusAdapter.resources.requests.memory

Description

The memory request for the Pod. Example: 500M.

.spec.distribution.modules.monitoring.prometheusAgent

Properties

Property	Type	Required
remoteWrite	`array`	Optional
resources	`object`	Optional

.spec.distribution.modules.monitoring.prometheusAgent.remoteWrite

Description

Set this option to ship the collected metrics to a remote Prometheus receiver.

remoteWrite is an array of objects that allows configuring the remoteWrite options for Prometheus. The objects in the array follow the same schema as in the prometheus operator.

.spec.distribution.modules.monitoring.prometheusAgent.resources

Properties

Property	Type	Required
limits	`object`	Optional
requests	`object`	Optional

.spec.distribution.modules.monitoring.prometheusAgent.resources.limits

Properties

Property	Type	Required
cpu	`string`	Optional
memory	`string`	Optional

.spec.distribution.modules.monitoring.prometheusAgent.resources.limits.cpu

Description

The CPU limit for the Pod. Example: 1000m.

.spec.distribution.modules.monitoring.prometheusAgent.resources.limits.memory

Description

The memory limit for the Pod. Example: 1G.

.spec.distribution.modules.monitoring.prometheusAgent.resources.requests

Properties

Property	Type	Required
cpu	`string`	Optional
memory	`string`	Optional

.spec.distribution.modules.monitoring.prometheusAgent.resources.requests.cpu

Description

The CPU request for the Pod, in cores. Example: 500m.

.spec.distribution.modules.monitoring.prometheusAgent.resources.requests.memory

Description

The memory request for the Pod. Example: 500M.

.spec.distribution.modules.monitoring.type

Description

The type of the monitoring, must be none, prometheus, prometheusAgent or mimir.

none: will disable the whole monitoring stack.
prometheus: will install Prometheus Operator and a preconfigured Prometheus instance, Alertmanager, a set of alert rules, exporters needed to monitor all the components of the cluster, Grafana and a series of dashboards to view the collected metrics, and more.
prometheusAgent: will install Prometheus operator, an instance of Prometheus in Agent mode (no alerting, no queries, no storage), and all the exporters needed to get metrics for the status of the cluster and the workloads. Useful when having a centralized (remote) Prometheus where to ship the metrics and not storing them locally in the cluster.
mimir: will install the same as the prometheus option, plus Grafana Mimir that allows for longer retention of metrics and the usage of Object Storage.

Default is prometheus.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"prometheus"`
`"prometheusAgent"`
`"mimir"`

.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

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.networking

Properties

Property	Type	Required
cilium	`object`	Optional
overrides	`object`	Optional
tigeraOperator	`object`	Optional
type	`string`	Required

Description

Configuration for the Networking module.

.spec.distribution.modules.networking.cilium

Properties

Property	Type	Required
maskSize	`string`	Required
overrides	`object`	Optional
podCidr	`string`	Required

.spec.distribution.modules.networking.cilium.maskSize

Description

The mask size to use for the Pods network on each node.

.spec.distribution.modules.networking.cilium.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.networking.cilium.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.networking.cilium.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.networking.cilium.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.networking.cilium.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.networking.cilium.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.networking.cilium.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.networking.cilium.podCidr

Description

Allows specifing a CIDR for the Pods network different from .spec.kubernetes.podCidr. If not set the default is to use .spec.kubernetes.podCidr.

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])$

try pattern

.spec.distribution.modules.networking.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the module.

.spec.distribution.modules.networking.overrides.ingresses

.spec.distribution.modules.networking.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the module.

.spec.distribution.modules.networking.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the module.

.spec.distribution.modules.networking.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.networking.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.networking.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.networking.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.networking.tigeraOperator

Properties

Property	Type	Required
blockSize	`integer`	Optional
overrides	`object`	Optional
podCidr	`string`	Optional

.spec.distribution.modules.networking.tigeraOperator.blockSize

Description

BlockSize specifies the CIDR prefix length to use when allocating per-node IP blocks from the main IP pool CIDR. WARNING: The value for this field cannot be changed once set. Default is 26.

.spec.distribution.modules.networking.tigeraOperator.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.networking.tigeraOperator.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.networking.tigeraOperator.podCidr

Description

Specifies a custom CIDR for the default Pods IPPool. If unset, the Tigera Operator will try to detect it from the cluster:

OpenShift -> OpenShift Network config
kubeadm -> kubeadm-config ConfigMap
EKS -> defaults to 172.16.0.0/16 (VXLAN)
otherwise -> defaults to 192.168.0.0/16. WARNING: this field cannot be changed once set.

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])$

try pattern

.spec.distribution.modules.networking.type

Description

The type of CNI plugin to use, either none, calico (Tigera Operator) or cilium.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"calico"`
`"cilium"`

.spec.distribution.modules.policy

Properties

Property	Type	Required
gatekeeper	`object`	Optional
kyverno	`object`	Optional
overrides	`object`	Optional
type	`string`	Required

Description

Configuration for the Policy module.

.spec.distribution.modules.policy.gatekeeper

Properties

Property	Type	Required
additionalExcludedNamespaces	`array`	Optional
enforcementAction	`string`	Required
installDefaultPolicies	`boolean`	Required
overrides	`object`	Optional

Description

Configuration for the Gatekeeper package.

.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 default enforcement action to use for the included constraints. deny will block the admission when violations to the policies are found, warn will show a message to the user but will admit the violating requests and dryrun won't give any feedback to the user but it will log the violations.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"deny"`
`"dryrun"`
`"warn"`

.spec.distribution.modules.policy.gatekeeper.installDefaultPolicies

Description

Set to false to avoid installing the default Gatekeeper policies (constraints templates and constraints) included with the distribution.

.spec.distribution.modules.policy.gatekeeper.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.policy.gatekeeper.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.policy.gatekeeper.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.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
installDefaultPolicies	`boolean`	Required
overrides	`object`	Optional
validationFailureAction	`string`	Required

Description

Configuration for the Kyverno package.

.spec.distribution.modules.policy.kyverno.additionalExcludedNamespaces

Description

This parameter adds namespaces to Kyverno's exemption list, so it will not enforce the policies on them.

.spec.distribution.modules.policy.kyverno.installDefaultPolicies

Description

Set to false to avoid installing the default Kyverno policies included with distribution.

.spec.distribution.modules.policy.kyverno.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.policy.kyverno.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.policy.kyverno.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.policy.kyverno.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.policy.kyverno.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.policy.kyverno.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.policy.kyverno.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.policy.kyverno.validationFailureAction

Description

The validation failure action to use for the included policies, Enforce will block when a request does not comply with the policies and Audit will not block but log when a request does not comply with the policies.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Audit"`
`"Enforce"`

.spec.distribution.modules.policy.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the module.

.spec.distribution.modules.policy.overrides.ingresses

.spec.distribution.modules.policy.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the module.

.spec.distribution.modules.policy.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the module.

.spec.distribution.modules.policy.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.policy.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.policy.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.policy.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.policy.type

Description

The type of policy enforcement to use, either none, gatekeeper or kyverno.

Default is none.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"gatekeeper"`
`"kyverno"`

.spec.distribution.modules.tracing

Properties

Property	Type	Required
minio	`object`	Optional
overrides	`object`	Optional
tempo	`object`	Optional
type	`string`	Required

Description

Configuration for the Tracing module.

.spec.distribution.modules.tracing.minio

Properties

Property	Type	Required
overrides	`object`	Optional
rootUser	`object`	Optional
storageSize	`string`	Optional

Description

Configuration for Tracing's MinIO deployment.

.spec.distribution.modules.tracing.minio.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.tracing.minio.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.tracing.minio.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.tracing.minio.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.tracing.minio.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.tracing.minio.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.tracing.minio.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.tracing.minio.rootUser

Properties

Property	Type	Required
password	`string`	Optional
username	`string`	Optional

.spec.distribution.modules.tracing.minio.rootUser.password

Description

The password for the default MinIO root user.

.spec.distribution.modules.tracing.minio.rootUser.username

Description

The username for the default MinIO root user.

.spec.distribution.modules.tracing.minio.storageSize

Description

The PVC size for each MinIO disk, 6 disks total.

.spec.distribution.modules.tracing.overrides

Properties

Property	Type	Required
ingresses	`object`	Optional
nodeSelector	`object`	Optional
tolerations	`array`	Optional

Description

Override the common configuration with a particular configuration for the module.

.spec.distribution.modules.tracing.overrides.ingresses

.spec.distribution.modules.tracing.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the module.

.spec.distribution.modules.tracing.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the module.

.spec.distribution.modules.tracing.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.tracing.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.tracing.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.spec.distribution.modules.tracing.overrides.tolerations.value

Description

The value of the toleration

.spec.distribution.modules.tracing.tempo

Properties

Property	Type	Required
backend	`string`	Optional
externalEndpoint	`object`	Optional
overrides	`object`	Optional
retentionTime	`string`	Optional

Description

Configuration for the Tempo package.

.spec.distribution.modules.tracing.tempo.backend

Description

The storage backend type for Tempo. minio will use an in-cluster MinIO deployment for object storage, externalEndpoint can be used to point to an external S3-compatible object storage instead of deploying an in-cluster MinIO.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"minio"`
`"externalEndpoint"`

.spec.distribution.modules.tracing.tempo.externalEndpoint

Properties

Property	Type	Required
accessKeyId	`string`	Optional
bucketName	`string`	Optional
endpoint	`string`	Optional
insecure	`boolean`	Optional
secretAccessKey	`string`	Optional

Description

Configuration for Tempo's external storage backend.

.spec.distribution.modules.tracing.tempo.externalEndpoint.accessKeyId

Description

The access key ID (username) for the external S3-compatible bucket.

.spec.distribution.modules.tracing.tempo.externalEndpoint.bucketName

Description

The bucket name of the external S3-compatible object storage.

.spec.distribution.modules.tracing.tempo.externalEndpoint.endpoint

Description

The external S3-compatible endpoint for Tempo's storage.

.spec.distribution.modules.tracing.tempo.externalEndpoint.insecure

Description

If true, will use HTTP as protocol instead of HTTPS.

.spec.distribution.modules.tracing.tempo.externalEndpoint.secretAccessKey

Description

The secret access key (password) for the external S3-compatible bucket.

.spec.distribution.modules.tracing.tempo.overrides

Properties

Property	Type	Required
nodeSelector	`object`	Optional
tolerations	`array`	Optional

.spec.distribution.modules.tracing.tempo.overrides.nodeSelector

Description

Set to override the node selector used to place the pods of the package.

.spec.distribution.modules.tracing.tempo.overrides.tolerations

Properties

Property	Type	Required
effect	`string`	Required
key	`string`	Required
operator	`string`	Optional
value	`string`	Optional

Description

Set to override the tolerations that will be added to the pods of the package.

.spec.distribution.modules.tracing.tempo.overrides.tolerations.effect

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"NoSchedule"`
`"PreferNoSchedule"`
`"NoExecute"`

.spec.distribution.modules.tracing.tempo.overrides.tolerations.key

Description

The key of the toleration

.spec.distribution.modules.tracing.tempo.overrides.tolerations.operator

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"Exists"`
`"Equal"`

.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 traces stored in Tempo.

.spec.distribution.modules.tracing.type

Description

The type of tracing to use, either none or tempo. none will disable the Tracing module and tempo will install a Grafana Tempo deployment.

Default is tempo.

Constraints

enum: the value of this property must be equal to one of the following string values:

Value
`"none"`
`"tempo"`

.spec.distributionVersion

Description

Defines which SD version will be installed and, in consequence, the Kubernetes version used to create the cluster. It supports git tags and branches. Example: v1.30.1.

Constraints

minimum length: the minimum number of characters for this string is: 1

.spec.plugins

Properties

Property	Type	Required
helm	`object`	Optional
kustomize	`array`	Optional

.spec.plugins.helm

Properties

Property	Type	Required
releases	`array`	Optional
repositories	`array`	Optional

.spec.plugins.helm.releases

Properties

Property	Type	Required
chart	`string`	Required
disableValidationOnInstall	`boolean`	Optional
name	`string`	Required
namespace	`string`	Required
set	`array`	Optional
values	`array`	Optional
version	`string`	Optional

.spec.plugins.helm.releases.chart

Description

The chart of the release

.spec.plugins.helm.releases.disableValidationOnInstall

Description

Disable running helm diff validation when installing the plugin, it will still be done when upgrading.

.spec.plugins.helm.releases.name

Description

The name of the release

.spec.plugins.helm.releases.namespace

Description

The namespace of the release

.spec.plugins.helm.releases.set

Properties

Property	Type	Required
name	`string`	Required
value	`string`	Required

.spec.plugins.helm.releases.set.name

Description

The name of the set

.spec.plugins.helm.releases.set.value

Description

The value of the set

.spec.plugins.helm.releases.values

Description

The values of the release

.spec.plugins.helm.releases.version

Description

The version of the release

.spec.plugins.helm.repositories

Properties

Property	Type	Required
name	`string`	Required
url	`string`	Required

.spec.plugins.helm.repositories.name

Description

The name of the repository

.spec.plugins.helm.repositories.url

Description

The url of the repository

.spec.plugins.kustomize

Properties

Property	Type	Required
folder	`string`	Required
name	`string`	Required

.spec.plugins.kustomize.folder

Description

The folder of the kustomize plugin

.spec.plugins.kustomize.name

Description

The name of the kustomize plugin. A lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', 'local-storage')

Constraints

pattern: the string must match the following regular expression:

^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

try pattern

Properties
- Description
.apiVersion
- Constraints
.flags
- Description
.kind
- Constraints
.metadata
- Properties
.metadata.name
- Description
- Constraints
.spec
- Properties
.spec.distribution
- Properties
.spec.distribution.common
- Properties
- Description
.spec.distribution.common.networkPoliciesEnabled
- Description
.spec.distribution.common.nodeSelector
- Description
.spec.distribution.common.provider
- Properties
.spec.distribution.common.provider.type
- Description
.spec.distribution.common.registry
- Description
.spec.distribution.common.relativeVendorPath
- Description
.spec.distribution.common.tolerations
- Properties
- Description
.spec.distribution.common.tolerations.effect
- Constraints
.spec.distribution.common.tolerations.key
- Description
.spec.distribution.common.tolerations.operator
- Constraints
.spec.distribution.common.tolerations.value
- Description
.spec.distribution.customPatches
- Properties
.spec.distribution.customPatches.configMapGenerator
- Properties
.spec.distribution.customPatches.configMapGenerator.behavior
- Description
- Constraints
.spec.distribution.customPatches.configMapGenerator.envs
- Description
.spec.distribution.customPatches.configMapGenerator.files
- Description
.spec.distribution.customPatches.configMapGenerator.literals
- Description
.spec.distribution.customPatches.configMapGenerator.name
- Description
.spec.distribution.customPatches.configMapGenerator.namespace
- Description
.spec.distribution.customPatches.configMapGenerator.options
- Properties
.spec.distribution.customPatches.configMapGenerator.options.annotations
- Description
.spec.distribution.customPatches.configMapGenerator.options.disableNameSuffixHash
- Description
.spec.distribution.customPatches.configMapGenerator.options.immutable
- Description
.spec.distribution.customPatches.configMapGenerator.options.labels
- Description
.spec.distribution.customPatches.images
- Description
.spec.distribution.customPatches.patches
- Properties
.spec.distribution.customPatches.patches.options
- Properties
.spec.distribution.customPatches.patches.options.allowKindChange
- Description
.spec.distribution.customPatches.patches.options.allowNameChange
- Description
.spec.distribution.customPatches.patches.patch
- Description
.spec.distribution.customPatches.patches.path
- Description
.spec.distribution.customPatches.patches.target
- Properties
.spec.distribution.customPatches.patches.target.annotationSelector
- Description
.spec.distribution.customPatches.patches.target.group
- Description
.spec.distribution.customPatches.patches.target.kind
- Description
.spec.distribution.customPatches.patches.target.labelSelector
- Description
.spec.distribution.customPatches.patches.target.name
- Description
.spec.distribution.customPatches.patches.target.namespace
- Description
.spec.distribution.customPatches.patches.target.version
- Description
.spec.distribution.customPatches.patchesStrategicMerge
- Description
.spec.distribution.customPatches.secretGenerator
- Properties
.spec.distribution.customPatches.secretGenerator.behavior
- Description
- Constraints
.spec.distribution.customPatches.secretGenerator.envs
- Description
.spec.distribution.customPatches.secretGenerator.files
- Description
.spec.distribution.customPatches.secretGenerator.literals
- Description
.spec.distribution.customPatches.secretGenerator.name
- Description
.spec.distribution.customPatches.secretGenerator.namespace
- Description
.spec.distribution.customPatches.secretGenerator.options
- Properties
.spec.distribution.customPatches.secretGenerator.options.annotations
- Description
.spec.distribution.customPatches.secretGenerator.options.disableNameSuffixHash
- Description
.spec.distribution.customPatches.secretGenerator.options.immutable
- Description
.spec.distribution.customPatches.secretGenerator.options.labels
- Description
.spec.distribution.customPatches.secretGenerator.type
- Description
.spec.distribution.kubeconfig
- Description
.spec.distribution.modules
- Properties
.spec.distribution.modules.auth
- Properties
- Description
.spec.distribution.modules.auth.baseDomain
- Description
.spec.distribution.modules.auth.dex
- Properties
- Description
.spec.distribution.modules.auth.dex.additionalStaticClients
- Description
.spec.distribution.modules.auth.dex.connectors
- Description
.spec.distribution.modules.auth.dex.expiry
- Properties
.spec.distribution.modules.auth.dex.expiry.idTokens
- Description
.spec.distribution.modules.auth.dex.expiry.signingKeys
- Description
.spec.distribution.modules.auth.dex.overrides
- Properties
.spec.distribution.modules.auth.dex.overrides.nodeSelector
- Description
.spec.distribution.modules.auth.dex.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.auth.dex.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.auth.dex.overrides.tolerations.key
- Description
.spec.distribution.modules.auth.dex.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.auth.dex.overrides.tolerations.value
- Description
.spec.distribution.modules.auth.oidcTrustedCA
- Description
.spec.distribution.modules.auth.overrides
- Properties
- Description
.spec.distribution.modules.auth.overrides.ingresses
- Description
.spec.distribution.modules.auth.overrides.nodeSelector
- Description
.spec.distribution.modules.auth.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.auth.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.auth.overrides.tolerations.key
- Description
.spec.distribution.modules.auth.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.auth.overrides.tolerations.value
- Description
.spec.distribution.modules.auth.pomerium
- Properties
- Description
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy
- Properties
- Description
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.gatekeeperPolicyManager
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.hubbleUi
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.ingressForecastle
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.loggingMinioConsole
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.loggingOpensearchDashboards
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringAlertmanager
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringGrafana
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringMinioConsole
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.monitoringPrometheus
.spec.distribution.modules.auth.pomerium.defaultRoutesPolicy.tracingMinioConsole
.spec.distribution.modules.auth.pomerium.overrides
- Properties
.spec.distribution.modules.auth.pomerium.overrides.nodeSelector
.spec.distribution.modules.auth.pomerium.overrides.tolerations
- Properties
.spec.distribution.modules.auth.pomerium.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.auth.pomerium.overrides.tolerations.key
.spec.distribution.modules.auth.pomerium.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.auth.pomerium.overrides.tolerations.value
.spec.distribution.modules.auth.pomerium.policy
- Description
.spec.distribution.modules.auth.pomerium.routes
- Description
.spec.distribution.modules.auth.pomerium.secrets
- Properties
- Description
.spec.distribution.modules.auth.pomerium.secrets.COOKIE_SECRET
- Description
.spec.distribution.modules.auth.pomerium.secrets.IDP_CLIENT_SECRET
- Description
.spec.distribution.modules.auth.pomerium.secrets.SHARED_SECRET
- Description
.spec.distribution.modules.auth.pomerium.secrets.SIGNING_KEY
- Description
.spec.distribution.modules.auth.provider
- Properties
.spec.distribution.modules.auth.provider.basicAuth
- Properties
- Description
.spec.distribution.modules.auth.provider.basicAuth.password
- Description
.spec.distribution.modules.auth.provider.basicAuth.username
- Description
.spec.distribution.modules.auth.provider.type
- Description
- Constraints
.spec.distribution.modules.dr
- Properties
- Description
.spec.distribution.modules.dr.overrides
- Properties
- Description
.spec.distribution.modules.dr.overrides.ingresses
.spec.distribution.modules.dr.overrides.nodeSelector
- Description
.spec.distribution.modules.dr.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.dr.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.dr.overrides.tolerations.key
- Description
.spec.distribution.modules.dr.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.dr.overrides.tolerations.value
- Description
.spec.distribution.modules.dr.type
- Description
- Constraints
.spec.distribution.modules.dr.velero
- Properties
- Description
.spec.distribution.modules.dr.velero.backend
- Description
- Constraints
.spec.distribution.modules.dr.velero.externalEndpoint
- Properties
- Description
.spec.distribution.modules.dr.velero.externalEndpoint.accessKeyId
- Description
.spec.distribution.modules.dr.velero.externalEndpoint.accessMode
- Description
- Constraints
.spec.distribution.modules.dr.velero.externalEndpoint.bucketName
- Description
.spec.distribution.modules.dr.velero.externalEndpoint.endpoint
- Description
.spec.distribution.modules.dr.velero.externalEndpoint.insecure
- Description
.spec.distribution.modules.dr.velero.externalEndpoint.prefixName
- Description
.spec.distribution.modules.dr.velero.externalEndpoint.secretAccessKey
- Description
.spec.distribution.modules.dr.velero.gcs
- Properties
- Description
.spec.distribution.modules.dr.velero.gcs.accessMode
- Description
- Constraints
.spec.distribution.modules.dr.velero.gcs.bucketName
- Description
.spec.distribution.modules.dr.velero.gcs.clientEmail
- Description
.spec.distribution.modules.dr.velero.gcs.prefixName
- Description
.spec.distribution.modules.dr.velero.gcs.serviceAccountString
- Description
.spec.distribution.modules.dr.velero.nodeAgent
- Properties
- Description
.spec.distribution.modules.dr.velero.nodeAgent.prepareQueueLength
- Description
.spec.distribution.modules.dr.velero.overrides
- Properties
.spec.distribution.modules.dr.velero.overrides.nodeSelector
- Description
.spec.distribution.modules.dr.velero.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.dr.velero.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.dr.velero.overrides.tolerations.key
- Description
.spec.distribution.modules.dr.velero.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.dr.velero.overrides.tolerations.value
- Description
.spec.distribution.modules.dr.velero.schedules
- Properties
- Description
.spec.distribution.modules.dr.velero.schedules.definitions
- Properties
- Description
.spec.distribution.modules.dr.velero.schedules.definitions.full
- Properties
- Description
.spec.distribution.modules.dr.velero.schedules.definitions.full.schedule
- Description
.spec.distribution.modules.dr.velero.schedules.definitions.full.snapshotMoveData
- Description
.spec.distribution.modules.dr.velero.schedules.definitions.full.ttl
- Description
.spec.distribution.modules.dr.velero.schedules.definitions.manifests
- Properties
- Description
.spec.distribution.modules.dr.velero.schedules.definitions.manifests.schedule
- Description
.spec.distribution.modules.dr.velero.schedules.definitions.manifests.ttl
- Description
.spec.distribution.modules.dr.velero.schedules.install
- Description
.spec.distribution.modules.dr.velero.snapshotController
- Properties
- Description
.spec.distribution.modules.dr.velero.snapshotController.install
- Description
.spec.distribution.modules.ingress
- Properties
.spec.distribution.modules.ingress.baseDomain
- Description
.spec.distribution.modules.ingress.byoic
- Properties
- Description
.spec.distribution.modules.ingress.byoic.commonAnnotations
- Description
.spec.distribution.modules.ingress.byoic.enabled
- Description
.spec.distribution.modules.ingress.byoic.ingressClass
- Description
.spec.distribution.modules.ingress.certManager
- Properties
- Description
.spec.distribution.modules.ingress.certManager.clusterIssuer
- Properties
- Description
.spec.distribution.modules.ingress.certManager.clusterIssuer.email
- Description
.spec.distribution.modules.ingress.certManager.clusterIssuer.name
- Description
.spec.distribution.modules.ingress.certManager.clusterIssuer.solvers
- Description
.spec.distribution.modules.ingress.certManager.clusterIssuer.type
- Description
- Constraints
.spec.distribution.modules.ingress.certManager.overrides
- Properties
.spec.distribution.modules.ingress.certManager.overrides.nodeSelector
- Description
.spec.distribution.modules.ingress.certManager.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.ingress.certManager.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.ingress.certManager.overrides.tolerations.key
- Description
.spec.distribution.modules.ingress.certManager.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.ingress.certManager.overrides.tolerations.value
- Description
.spec.distribution.modules.ingress.forecastle
- Properties
.spec.distribution.modules.ingress.forecastle.overrides
- Properties
.spec.distribution.modules.ingress.forecastle.overrides.nodeSelector
- Description
.spec.distribution.modules.ingress.forecastle.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.key
- Description
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.ingress.forecastle.overrides.tolerations.value
- Description
.spec.distribution.modules.ingress.haproxy
- Properties
- Description
.spec.distribution.modules.ingress.haproxy.overrides
- Properties
.spec.distribution.modules.ingress.haproxy.overrides.nodeSelector
- Description
.spec.distribution.modules.ingress.haproxy.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.ingress.haproxy.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.ingress.haproxy.overrides.tolerations.key
- Description
.spec.distribution.modules.ingress.haproxy.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.ingress.haproxy.overrides.tolerations.value
- Description
.spec.distribution.modules.ingress.haproxy.tls
- Properties
- Description
.spec.distribution.modules.ingress.haproxy.tls.provider
- Description
- Constraints
.spec.distribution.modules.ingress.haproxy.tls.secret
- Properties
- Description
.spec.distribution.modules.ingress.haproxy.tls.secret.ca
- Description
.spec.distribution.modules.ingress.haproxy.tls.secret.cert
- Description
.spec.distribution.modules.ingress.haproxy.tls.secret.key
- Description
.spec.distribution.modules.ingress.haproxy.type
- Description
- Constraints
.spec.distribution.modules.ingress.infrastructureIngressController
- Description
.spec.distribution.modules.ingress.nginx
- Properties
- Description
.spec.distribution.modules.ingress.nginx.overrides
- Properties
.spec.distribution.modules.ingress.nginx.overrides.nodeSelector
- Description
.spec.distribution.modules.ingress.nginx.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.ingress.nginx.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.ingress.nginx.overrides.tolerations.key
- Description
.spec.distribution.modules.ingress.nginx.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.ingress.nginx.overrides.tolerations.value
- Description
.spec.distribution.modules.ingress.nginx.tls
- Properties
- Description
.spec.distribution.modules.ingress.nginx.tls.provider
- Description
- Constraints
.spec.distribution.modules.ingress.nginx.tls.secret
- Properties
- Description
.spec.distribution.modules.ingress.nginx.tls.secret.ca
- Description
.spec.distribution.modules.ingress.nginx.tls.secret.cert
- Description
.spec.distribution.modules.ingress.nginx.tls.secret.key
- Description
.spec.distribution.modules.ingress.nginx.type
- Description
- Constraints
.spec.distribution.modules.ingress.overrides
- Properties
- Description
.spec.distribution.modules.ingress.overrides.ingresses
- Properties
.spec.distribution.modules.ingress.overrides.ingresses.forecastle
- Properties
.spec.distribution.modules.ingress.overrides.ingresses.forecastle.disableAuth
- Description
.spec.distribution.modules.ingress.overrides.ingresses.forecastle.host
- Description
.spec.distribution.modules.ingress.overrides.ingresses.forecastle.ingressClass
- Description
.spec.distribution.modules.ingress.overrides.nodeSelector
- Description
.spec.distribution.modules.ingress.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.ingress.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.ingress.overrides.tolerations.key
- Description
.spec.distribution.modules.ingress.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.ingress.overrides.tolerations.value
- Description
.spec.distribution.modules.logging
- Properties
- Description
.spec.distribution.modules.logging.cerebro
- Properties
- Description
.spec.distribution.modules.logging.cerebro.overrides
- Properties
.spec.distribution.modules.logging.cerebro.overrides.nodeSelector
- Description
.spec.distribution.modules.logging.cerebro.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.logging.cerebro.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.logging.cerebro.overrides.tolerations.key
- Description
.spec.distribution.modules.logging.cerebro.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.logging.cerebro.overrides.tolerations.value
- Description
.spec.distribution.modules.logging.customOutputs
- Properties
- Description
.spec.distribution.modules.logging.customOutputs.audit
- Description
.spec.distribution.modules.logging.customOutputs.errors
- Description
.spec.distribution.modules.logging.customOutputs.events
- Description
.spec.distribution.modules.logging.customOutputs.infra
- Description
.spec.distribution.modules.logging.customOutputs.ingressHaproxy
- Description
.spec.distribution.modules.logging.customOutputs.ingressNginx
- Description
.spec.distribution.modules.logging.customOutputs.kubernetes
- Description
.spec.distribution.modules.logging.customOutputs.systemdCommon
- Description
.spec.distribution.modules.logging.customOutputs.systemdEtcd
- Description
.spec.distribution.modules.logging.loki
- Properties
- Description
.spec.distribution.modules.logging.loki.backend
- Description
- Constraints
.spec.distribution.modules.logging.loki.externalEndpoint
- Properties
- Description
.spec.distribution.modules.logging.loki.externalEndpoint.accessKeyId
- Description
.spec.distribution.modules.logging.loki.externalEndpoint.bucketName
- Description
.spec.distribution.modules.logging.loki.externalEndpoint.endpoint
- Description
.spec.distribution.modules.logging.loki.externalEndpoint.insecure
- Description
.spec.distribution.modules.logging.loki.externalEndpoint.secretAccessKey
- Description
.spec.distribution.modules.logging.loki.resources
- Properties
.spec.distribution.modules.logging.loki.resources.limits
- Properties
.spec.distribution.modules.logging.loki.resources.limits.cpu
- Description
.spec.distribution.modules.logging.loki.resources.limits.memory
- Description
.spec.distribution.modules.logging.loki.resources.requests
- Properties
.spec.distribution.modules.logging.loki.resources.requests.cpu
- Description
.spec.distribution.modules.logging.loki.resources.requests.memory
- Description
.spec.distribution.modules.logging.loki.retentionTime
- Description
.spec.distribution.modules.logging.loki.tsdbStartDate
- Description
.spec.distribution.modules.logging.minio
- Properties
- Description
.spec.distribution.modules.logging.minio.overrides
- Properties
.spec.distribution.modules.logging.minio.overrides.nodeSelector
- Description
.spec.distribution.modules.logging.minio.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.logging.minio.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.logging.minio.overrides.tolerations.key
- Description
.spec.distribution.modules.logging.minio.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.logging.minio.overrides.tolerations.value
- Description
.spec.distribution.modules.logging.minio.rootUser
- Properties
.spec.distribution.modules.logging.minio.rootUser.password
- Description
.spec.distribution.modules.logging.minio.rootUser.username
- Description
.spec.distribution.modules.logging.minio.storageSize
- Description
.spec.distribution.modules.logging.opensearch
- Properties
.spec.distribution.modules.logging.opensearch.overrides
- Properties
.spec.distribution.modules.logging.opensearch.overrides.nodeSelector
- Description
.spec.distribution.modules.logging.opensearch.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.logging.opensearch.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.logging.opensearch.overrides.tolerations.key
- Description
.spec.distribution.modules.logging.opensearch.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.logging.opensearch.overrides.tolerations.value
- Description
.spec.distribution.modules.logging.opensearch.resources
- Properties
.spec.distribution.modules.logging.opensearch.resources.limits
- Properties
.spec.distribution.modules.logging.opensearch.resources.limits.cpu
- Description
.spec.distribution.modules.logging.opensearch.resources.limits.memory
- Description
.spec.distribution.modules.logging.opensearch.resources.requests
- Properties
.spec.distribution.modules.logging.opensearch.resources.requests.cpu
- Description
.spec.distribution.modules.logging.opensearch.resources.requests.memory
- Description
.spec.distribution.modules.logging.opensearch.storageSize
- Description
.spec.distribution.modules.logging.opensearch.type
- Description
- Constraints
.spec.distribution.modules.logging.operator
- Properties
- Description
.spec.distribution.modules.logging.operator.overrides
- Properties
.spec.distribution.modules.logging.operator.overrides.nodeSelector
- Description
.spec.distribution.modules.logging.operator.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.logging.operator.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.logging.operator.overrides.tolerations.key
- Description
.spec.distribution.modules.logging.operator.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.logging.operator.overrides.tolerations.value
- Description
.spec.distribution.modules.logging.overrides
- Properties
- Description
.spec.distribution.modules.logging.overrides.ingresses
.spec.distribution.modules.logging.overrides.nodeSelector
- Description
.spec.distribution.modules.logging.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.logging.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.logging.overrides.tolerations.key
- Description
.spec.distribution.modules.logging.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.logging.overrides.tolerations.value
- Description
.spec.distribution.modules.logging.type
- Description
- Constraints
.spec.distribution.modules.monitoring
- Properties
- Description
.spec.distribution.modules.monitoring.alertmanager
- Properties
.spec.distribution.modules.monitoring.alertmanager.deadManSwitchWebhookUrl
- Description
.spec.distribution.modules.monitoring.alertmanager.installDefaultRules
- Description
.spec.distribution.modules.monitoring.alertmanager.slackWebhookUrl
- Description
.spec.distribution.modules.monitoring.blackboxExporter
- Properties
.spec.distribution.modules.monitoring.blackboxExporter.overrides
- Properties
.spec.distribution.modules.monitoring.blackboxExporter.overrides.nodeSelector
- Description
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.key
- Description
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.monitoring.blackboxExporter.overrides.tolerations.value
- Description
.spec.distribution.modules.monitoring.grafana
- Properties
.spec.distribution.modules.monitoring.grafana.basicAuthIngress
- Description
.spec.distribution.modules.monitoring.grafana.overrides
- Properties
.spec.distribution.modules.monitoring.grafana.overrides.nodeSelector
- Description
.spec.distribution.modules.monitoring.grafana.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.key
- Description
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.monitoring.grafana.overrides.tolerations.value
- Description
.spec.distribution.modules.monitoring.grafana.usersRoleAttributePath
- Description
.spec.distribution.modules.monitoring.kubeStateMetrics
- Properties
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides
- Properties
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.nodeSelector
- Description
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.key
- Description
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.monitoring.kubeStateMetrics.overrides.tolerations.value
- Description
.spec.distribution.modules.monitoring.mimir
- Properties
- Description
.spec.distribution.modules.monitoring.mimir.backend
- Description
- Constraints
.spec.distribution.modules.monitoring.mimir.externalEndpoint
- Properties
- Description
.spec.distribution.modules.monitoring.mimir.externalEndpoint.accessKeyId
- Description
.spec.distribution.modules.monitoring.mimir.externalEndpoint.bucketName
- Description
.spec.distribution.modules.monitoring.mimir.externalEndpoint.endpoint
- Description
.spec.distribution.modules.monitoring.mimir.externalEndpoint.insecure
- Description
.spec.distribution.modules.monitoring.mimir.externalEndpoint.secretAccessKey
- Description
.spec.distribution.modules.monitoring.mimir.overrides
- Properties
.spec.distribution.modules.monitoring.mimir.overrides.nodeSelector
- Description
.spec.distribution.modules.monitoring.mimir.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.key
- Description
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.monitoring.mimir.overrides.tolerations.value
- Description
.spec.distribution.modules.monitoring.mimir.retentionTime
- Description
.spec.distribution.modules.monitoring.minio
- Properties
- Description
.spec.distribution.modules.monitoring.minio.overrides
- Properties
.spec.distribution.modules.monitoring.minio.overrides.nodeSelector
- Description
.spec.distribution.modules.monitoring.minio.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.monitoring.minio.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.monitoring.minio.overrides.tolerations.key
- Description
.spec.distribution.modules.monitoring.minio.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.monitoring.minio.overrides.tolerations.value
- Description
.spec.distribution.modules.monitoring.minio.rootUser
- Properties
.spec.distribution.modules.monitoring.minio.rootUser.password
- Description
.spec.distribution.modules.monitoring.minio.rootUser.username
- Description
.spec.distribution.modules.monitoring.minio.storageSize
- Description
.spec.distribution.modules.monitoring.overrides
- Properties
- Description
.spec.distribution.modules.monitoring.overrides.ingresses
.spec.distribution.modules.monitoring.overrides.nodeSelector
- Description
.spec.distribution.modules.monitoring.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.monitoring.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.monitoring.overrides.tolerations.key
- Description
.spec.distribution.modules.monitoring.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.monitoring.overrides.tolerations.value
- Description
.spec.distribution.modules.monitoring.prometheus
- Properties
.spec.distribution.modules.monitoring.prometheus.remoteWrite
- Description
.spec.distribution.modules.monitoring.prometheus.resources
- Properties
.spec.distribution.modules.monitoring.prometheus.resources.limits
- Properties
.spec.distribution.modules.monitoring.prometheus.resources.limits.cpu
- Description
.spec.distribution.modules.monitoring.prometheus.resources.limits.memory
- Description
.spec.distribution.modules.monitoring.prometheus.resources.requests
- Properties
.spec.distribution.modules.monitoring.prometheus.resources.requests.cpu
- Description
.spec.distribution.modules.monitoring.prometheus.resources.requests.memory
- Description
.spec.distribution.modules.monitoring.prometheus.retentionSize
- Description
.spec.distribution.modules.monitoring.prometheus.retentionTime
- Description
.spec.distribution.modules.monitoring.prometheus.storageSize
- Description
.spec.distribution.modules.monitoring.prometheusAdapter
- Properties
.spec.distribution.modules.monitoring.prometheusAdapter.installEnhancedHPAMetrics
- Description
.spec.distribution.modules.monitoring.prometheusAdapter.resources
- Properties
.spec.distribution.modules.monitoring.prometheusAdapter.resources.limits
- Properties
.spec.distribution.modules.monitoring.prometheusAdapter.resources.limits.cpu
- Description
.spec.distribution.modules.monitoring.prometheusAdapter.resources.limits.memory
- Description
.spec.distribution.modules.monitoring.prometheusAdapter.resources.requests
- Properties
.spec.distribution.modules.monitoring.prometheusAdapter.resources.requests.cpu
- Description
.spec.distribution.modules.monitoring.prometheusAdapter.resources.requests.memory
- Description
.spec.distribution.modules.monitoring.prometheusAgent
- Properties
.spec.distribution.modules.monitoring.prometheusAgent.remoteWrite
- Description
.spec.distribution.modules.monitoring.prometheusAgent.resources
- Properties
.spec.distribution.modules.monitoring.prometheusAgent.resources.limits
- Properties
.spec.distribution.modules.monitoring.prometheusAgent.resources.limits.cpu
- Description
.spec.distribution.modules.monitoring.prometheusAgent.resources.limits.memory
- Description
.spec.distribution.modules.monitoring.prometheusAgent.resources.requests
- Properties
.spec.distribution.modules.monitoring.prometheusAgent.resources.requests.cpu
- Description
.spec.distribution.modules.monitoring.prometheusAgent.resources.requests.memory
- Description
.spec.distribution.modules.monitoring.type
- Description
- Constraints
.spec.distribution.modules.monitoring.x509Exporter
- Properties
.spec.distribution.modules.monitoring.x509Exporter.overrides
- Properties
.spec.distribution.modules.monitoring.x509Exporter.overrides.nodeSelector
- Description
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.key
- Description
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.monitoring.x509Exporter.overrides.tolerations.value
- Description
.spec.distribution.modules.networking
- Properties
- Description
.spec.distribution.modules.networking.cilium
- Properties
.spec.distribution.modules.networking.cilium.maskSize
- Description
.spec.distribution.modules.networking.cilium.overrides
- Properties
.spec.distribution.modules.networking.cilium.overrides.nodeSelector
- Description
.spec.distribution.modules.networking.cilium.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.networking.cilium.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.networking.cilium.overrides.tolerations.key
- Description
.spec.distribution.modules.networking.cilium.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.networking.cilium.overrides.tolerations.value
- Description
.spec.distribution.modules.networking.cilium.podCidr
- Description
- Constraints
.spec.distribution.modules.networking.overrides
- Properties
- Description
.spec.distribution.modules.networking.overrides.ingresses
.spec.distribution.modules.networking.overrides.nodeSelector
- Description
.spec.distribution.modules.networking.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.networking.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.networking.overrides.tolerations.key
- Description
.spec.distribution.modules.networking.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.networking.overrides.tolerations.value
- Description
.spec.distribution.modules.networking.tigeraOperator
- Properties
.spec.distribution.modules.networking.tigeraOperator.blockSize
- Description
.spec.distribution.modules.networking.tigeraOperator.overrides
- Properties
.spec.distribution.modules.networking.tigeraOperator.overrides.nodeSelector
- Description
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.key
- Description
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.networking.tigeraOperator.overrides.tolerations.value
- Description
.spec.distribution.modules.networking.tigeraOperator.podCidr
- Description
- Constraints
.spec.distribution.modules.networking.type
- Description
- Constraints
.spec.distribution.modules.policy
- Properties
- Description
.spec.distribution.modules.policy.gatekeeper
- Properties
- Description
.spec.distribution.modules.policy.gatekeeper.additionalExcludedNamespaces
- Description
.spec.distribution.modules.policy.gatekeeper.enforcementAction
- Description
- Constraints
.spec.distribution.modules.policy.gatekeeper.installDefaultPolicies
- Description
.spec.distribution.modules.policy.gatekeeper.overrides
- Properties
.spec.distribution.modules.policy.gatekeeper.overrides.nodeSelector
- Description
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.key
- Description
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.policy.gatekeeper.overrides.tolerations.value
- Description
.spec.distribution.modules.policy.kyverno
- Properties
- Description
.spec.distribution.modules.policy.kyverno.additionalExcludedNamespaces
- Description
.spec.distribution.modules.policy.kyverno.installDefaultPolicies
- Description
.spec.distribution.modules.policy.kyverno.overrides
- Properties
.spec.distribution.modules.policy.kyverno.overrides.nodeSelector
- Description
.spec.distribution.modules.policy.kyverno.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.policy.kyverno.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.policy.kyverno.overrides.tolerations.key
- Description
.spec.distribution.modules.policy.kyverno.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.policy.kyverno.overrides.tolerations.value
- Description
.spec.distribution.modules.policy.kyverno.validationFailureAction
- Description
- Constraints
.spec.distribution.modules.policy.overrides
- Properties
- Description
.spec.distribution.modules.policy.overrides.ingresses
.spec.distribution.modules.policy.overrides.nodeSelector
- Description
.spec.distribution.modules.policy.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.policy.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.policy.overrides.tolerations.key
- Description
.spec.distribution.modules.policy.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.policy.overrides.tolerations.value
- Description
.spec.distribution.modules.policy.type
- Description
- Constraints
.spec.distribution.modules.tracing
- Properties
- Description
.spec.distribution.modules.tracing.minio
- Properties
- Description
.spec.distribution.modules.tracing.minio.overrides
- Properties
.spec.distribution.modules.tracing.minio.overrides.nodeSelector
- Description
.spec.distribution.modules.tracing.minio.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.tracing.minio.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.tracing.minio.overrides.tolerations.key
- Description
.spec.distribution.modules.tracing.minio.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.tracing.minio.overrides.tolerations.value
- Description
.spec.distribution.modules.tracing.minio.rootUser
- Properties
.spec.distribution.modules.tracing.minio.rootUser.password
- Description
.spec.distribution.modules.tracing.minio.rootUser.username
- Description
.spec.distribution.modules.tracing.minio.storageSize
- Description
.spec.distribution.modules.tracing.overrides
- Properties
- Description
.spec.distribution.modules.tracing.overrides.ingresses
.spec.distribution.modules.tracing.overrides.nodeSelector
- Description
.spec.distribution.modules.tracing.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.tracing.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.tracing.overrides.tolerations.key
- Description
.spec.distribution.modules.tracing.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.tracing.overrides.tolerations.value
- Description
.spec.distribution.modules.tracing.tempo
- Properties
- Description
.spec.distribution.modules.tracing.tempo.backend
- Description
- Constraints
.spec.distribution.modules.tracing.tempo.externalEndpoint
- Properties
- Description
.spec.distribution.modules.tracing.tempo.externalEndpoint.accessKeyId
- Description
.spec.distribution.modules.tracing.tempo.externalEndpoint.bucketName
- Description
.spec.distribution.modules.tracing.tempo.externalEndpoint.endpoint
- Description
.spec.distribution.modules.tracing.tempo.externalEndpoint.insecure
- Description
.spec.distribution.modules.tracing.tempo.externalEndpoint.secretAccessKey
- Description
.spec.distribution.modules.tracing.tempo.overrides
- Properties
.spec.distribution.modules.tracing.tempo.overrides.nodeSelector
- Description
.spec.distribution.modules.tracing.tempo.overrides.tolerations
- Properties
- Description
.spec.distribution.modules.tracing.tempo.overrides.tolerations.effect
- Constraints
.spec.distribution.modules.tracing.tempo.overrides.tolerations.key
- Description
.spec.distribution.modules.tracing.tempo.overrides.tolerations.operator
- Constraints
.spec.distribution.modules.tracing.tempo.overrides.tolerations.value
- Description
.spec.distribution.modules.tracing.tempo.retentionTime
- Description
.spec.distribution.modules.tracing.type
- Description
- Constraints
.spec.distributionVersion
- Description
- Constraints
.spec.plugins
- Properties
.spec.plugins.helm
- Properties
.spec.plugins.helm.releases
- Properties
.spec.plugins.helm.releases.chart
- Description
.spec.plugins.helm.releases.disableValidationOnInstall
- Description
.spec.plugins.helm.releases.name
- Description
.spec.plugins.helm.releases.namespace
- Description
.spec.plugins.helm.releases.set
- Properties
.spec.plugins.helm.releases.set.name
- Description
.spec.plugins.helm.releases.set.value
- Description
.spec.plugins.helm.releases.values
- Description
.spec.plugins.helm.releases.version
- Description
.spec.plugins.helm.repositories
- Properties
.spec.plugins.helm.repositories.name
- Description
.spec.plugins.helm.repositories.url
- Description
.spec.plugins.kustomize
- Properties
.spec.plugins.kustomize.folder
- Description
.spec.plugins.kustomize.name
- Description
- Constraints

Properties​

Description​

.apiVersion​

Constraints​

.flags​

Description​

.kind​

Constraints​

.metadata​

Properties​

.metadata.name​

Description​

Constraints​

.spec​

Properties​

.spec.distribution​

Properties​

.spec.distribution.common​

Properties​

Description​

.spec.distribution.common.networkPoliciesEnabled​

Description​

.spec.distribution.common.nodeSelector​

Description​

.spec.distribution.common.provider​

Properties​

.spec.distribution.common.provider.type​

Description​

.spec.distribution.common.registry​

Description​

.spec.distribution.common.relativeVendorPath​

Description​

.spec.distribution.common.tolerations​

Properties​

Description​

.spec.distribution.common.tolerations.effect​

Constraints​

.spec.distribution.common.tolerations.key​

Description​

.spec.distribution.common.tolerations.operator​

Constraints​

.spec.distribution.common.tolerations.value​

Description​

.spec.distribution.customPatches​

Properties​

.spec.distribution.customPatches.configMapGenerator​

Properties​

.spec.distribution.customPatches.configMapGenerator.behavior​

Description​

Constraints​

.spec.distribution.customPatches.configMapGenerator.envs​

Description​

.spec.distribution.customPatches.configMapGenerator.files​

Description​

.spec.distribution.customPatches.configMapGenerator.literals​

Description​

.spec.distribution.customPatches.configMapGenerator.name​

Description​

.spec.distribution.customPatches.configMapGenerator.namespace​

Description​

.spec.distribution.customPatches.configMapGenerator.options​

Properties​

.spec.distribution.customPatches.configMapGenerator.options.annotations​

Description​

.spec.distribution.customPatches.configMapGenerator.options.disableNameSuffixHash​

Description​

.spec.distribution.customPatches.configMapGenerator.options.immutable​

Description​

.spec.distribution.customPatches.configMapGenerator.options.labels​

Description​

.spec.distribution.customPatches.images​

Description​

.spec.distribution.customPatches.patches​

Properties​

.spec.distribution.customPatches.patches.options​

Properties​

.spec.distribution.customPatches.patches.options.allowKindChange​

Description​

.spec.distribution.customPatches.patches.options.allowNameChange​

Description​

Properties

Description

.apiVersion

Constraints

.flags

Description

.kind

Constraints

.metadata

Properties

.metadata.name

Description

Constraints

.spec

Properties

.spec.distribution

Properties

.spec.distribution.common

Properties

Description

.spec.distribution.common.networkPoliciesEnabled

Description

.spec.distribution.common.nodeSelector

Description

.spec.distribution.common.provider

Properties

.spec.distribution.common.provider.type

Description

.spec.distribution.common.registry

Description

.spec.distribution.common.relativeVendorPath

Description

.spec.distribution.common.tolerations

Properties

Description

.spec.distribution.common.tolerations.effect

Constraints

.spec.distribution.common.tolerations.key

Description

.spec.distribution.common.tolerations.operator

Constraints

.spec.distribution.common.tolerations.value

Description

.spec.distribution.customPatches

Properties

.spec.distribution.customPatches.configMapGenerator

Properties

.spec.distribution.customPatches.configMapGenerator.behavior

Description

Constraints

.spec.distribution.customPatches.configMapGenerator.envs

Description

.spec.distribution.customPatches.configMapGenerator.files

Description

.spec.distribution.customPatches.configMapGenerator.literals

Description

.spec.distribution.customPatches.configMapGenerator.name

Description

.spec.distribution.customPatches.configMapGenerator.namespace

Description

.spec.distribution.customPatches.configMapGenerator.options

Properties

.spec.distribution.customPatches.configMapGenerator.options.annotations

Description

.spec.distribution.customPatches.configMapGenerator.options.disableNameSuffixHash

Description

.spec.distribution.customPatches.configMapGenerator.options.immutable

Description

.spec.distribution.customPatches.configMapGenerator.options.labels

Description

.spec.distribution.customPatches.images

Description

.spec.distribution.customPatches.patches

Properties

.spec.distribution.customPatches.patches.options

Properties

.spec.distribution.customPatches.patches.options.allowKindChange

Description

.spec.distribution.customPatches.patches.options.allowNameChange

Description