apiVersion
string

extensions.kubeblocks.io/v1alpha1

kind
string

Addon

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

AddonInstallSpec

(Members of AddonInstallSpec are embedded into this type.)

selectors

Indicates the default selectors for add-on installations. If multiple selectors are provided, all selectors must evaluate to true.

AddonInstallSpecItem

(Members of AddonInstallSpecItem are embedded into this type.)

name

Specifies the name of the item.

AddonInstallSpecItem

(Members of AddonInstallSpecItem are embedded into this type.)

enabled

Can be set to true if there are no specific installation attributes to be set.

extras

Specifies the installation specifications for extra items.

replicas

Specifies the number of replicas.

persistentVolumeEnabled

Indicates whether the Persistent Volume is enabled or not.

storageClass

Specifies the name of the storage class.

tolerations

Specifies the tolerations in a JSON array string format.

resources

Specifies the resource requirements.

"Disabled"

"Disabling"

"Enabled"

"Enabling"

"Failed"

"KubeGitVersion"

"KubeProvider"

"KubeVersion"

description

Specifies the description of the add-on.

type

Defines the type of the add-on. The only valid value is ‘helm’.

version

Indicates the version of the add-on.

provider

Specifies the provider of the add-on.

helm

Represents the Helm installation specifications. This is only processed when the type is set to ‘helm’.

defaultInstallValues

Specifies the default installation parameters.

install

Defines the installation parameters.

installable

Represents the installable specifications of the add-on. This includes the selector and auto-install settings.

cliPlugins

Specifies the CLI plugin installation specifications.

phase

Defines the current installation phase of the add-on. It can take one of the following values: Disabled, Enabled, Failed, Enabling, Disabling.

conditions

Provides a detailed description of the current state of add-on API installation.

observedGeneration

Represents the most recent generation observed for this add-on. It corresponds to the add-on’s generation, which is updated on mutation by the API Server.

"Helm"

name

Specifies the name of the plugin.

indexRepository

Defines the index repository of the plugin.

description

Provides a brief description of the plugin.

name

Defines the name of the object being referred to.

key

Specifies the key to be selected.

urls

Specifies the URL location of the values file.

configMapRefs

Selects a key from a ConfigMap item list. The value can be a JSON or YAML string content. Use a key name with “.json”, “.yaml”, or “.yml” extension to specify a content type.

secretRefs

Selects a key from a Secrets item list. The value can be a JSON or YAML string content. Use a key name with “.json”, “.yaml”, or “.yml” extension to specify a content type.

setValues

Values set during Helm installation. Multiple or separate values can be specified with commas (key1=val1,key2=val2).

setJSONValues

JSON values set during Helm installation. Multiple or separate values can be specified with commas (key1=jsonval1,key2=jsonval2).

tolerations

Specifies the toleration mapping key.

chartLocationURL

Specifies the URL location of the Helm Chart.

installOptions

Defines the options for Helm release installation.

installValues

Defines the set values for Helm release installation.

valuesMapping

Defines the mapping of add-on normalized resources parameters to Helm values’ keys.

chartsImage

Defines the image of Helm charts.

chartsPathInImage

Defines the path of Helm charts in the image. This path is used to copy Helm charts from the image to the shared volume. The default path is “/charts”.

replicaCount

Defines the key for setting the replica count in the Helm values map.

persistentVolumeEnabled

Indicates whether the persistent volume is enabled in the Helm values map.

storageClass

Specifies the key for setting the storage class in the Helm values map.

HelmValuesMappingItem

(Members of HelmValuesMappingItem are embedded into this type.)

extras

Helm value mapping items for extra items.

HelmValuesMappingItem

(Members of HelmValuesMappingItem are embedded into this type.)

name

Name of the item.

valueMap

Defines the “key” mapping values. Valid keys include replicaCount, persistentVolumeEnabled, and storageClass. Enum values explained:

• replicaCount sets the replicaCount value mapping key.

• persistentVolumeEnabled sets the persistent volume enabled mapping key.

• storageClass sets the storageClass mapping key.

jsonMap

Defines the “key” mapping values. The valid key is tolerations. Enum values explained:

• tolerations sets the toleration mapping key.

resources

Sets resources related mapping keys.

selectors

Specifies the selectors for add-on installation. If multiple selectors are provided, they must all evaluate to true for the add-on to be installed.

autoInstall

Indicates whether an add-on should be installed automatically.

"Contains"

"DoesNotContain"

"DoesNotMatchRegex"

"MatchRegex"

storage

Specifies the key used for mapping the storage size value.

cpu

Specifies the key used for mapping both CPU requests and limits.

memory

Specifies the key used for mapping both Memory requests and limits.

requests

Specifies the mapping key for the request value.

limits

Specifies the mapping key for the limit value.

limits

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/.

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified; otherwise, it defaults to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/.

key

The selector key. Valid values are KubeVersion, KubeGitVersion and KubeProvider.

• KubeVersion the semver expression of Kubernetes versions, i.e., v1.24.

• KubeGitVersion may contain distro. info., i.e., v1.24.4+eks.

• KubeProvider the Kubernetes provider, i.e., aws, gcp, azure, huaweiCloud, tencentCloud etc.

operator

Represents a key’s relationship to a set of values. Valid operators are Contains, NotIn, DoesNotContain, MatchRegex, and DoesNoteMatchRegex.

Possible enum values:

• Contains line contains a string.

• DoesNotContain line does not contain a string.

• MatchRegex line contains a match to the regular expression.

• DoesNotMatchRegex line does not contain a match to the regular expression.

values

Represents an array of string values. This serves as an “OR” expression to the operator.