Skip to main content
Version: release-0.7

Add-On API Reference


Packages:

extensions.kubeblocks.io/v1alpha1

Resource Types:

Addon

Addon is the Schema for the add-ons API.


FieldDescription
apiVersion
string
extensions.kubeblocks.io/v1alpha1
kind
string
Addon
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of themetadata field.
spec
AddonSpec


description
string
(Optional)

Addon description.


type
AddonType

Add-on type. The valid value is helm.


helm
HelmTypeInstallSpec
(Optional)

Helm installation spec. It’s processed only when type=helm.


defaultInstallValues
[]AddonDefaultInstallSpecItem

Default installation parameters.


install
AddonInstallSpec
(Optional)

Installation parameters.


installable
InstallableSpec
(Optional)

Addon installable spec. It provides selector and auto-install settings.


cliPlugins
[]CliPlugin
(Optional)

Plugin installation spec.


status
AddonStatus

AddonDefaultInstallSpecItem

(Appears on:AddonSpec)

FieldDescription
AddonInstallSpec
AddonInstallSpec

(Members of AddonInstallSpec are embedded into this type.)

selectors
[]SelectorRequirement
(Optional)

Addon installs parameters selectors by default. If multiple selectors are provided,
all selectors must evaluate to true.


AddonInstallExtraItem

(Appears on:AddonInstallSpec)

FieldDescription
AddonInstallSpecItem
AddonInstallSpecItem

(Members of AddonInstallSpecItem are embedded into this type.)

name
string

Name of the item.


AddonInstallSpec

(Appears on:AddonDefaultInstallSpecItem, AddonSpec)

FieldDescription
AddonInstallSpecItem
AddonInstallSpecItem

(Members of AddonInstallSpecItem are embedded into this type.)

enabled
bool
(Optional)

enabled can be set if there are no specific installation attributes to be set.


extras
[]AddonInstallExtraItem
(Optional)

Installs spec. for extra items.


AddonInstallSpecItem

(Appears on:AddonInstallExtraItem, AddonInstallSpec)

FieldDescription
replicas
int32
(Optional)

Replicas value.


persistentVolumeEnabled
bool
(Optional)

Persistent Volume Enabled value.


storageClass
string
(Optional)

Storage class name.


tolerations
string
(Optional)

Tolerations JSON array string value.


resources
ResourceRequirements
(Optional)

Resource requirements.


AddonPhase (string alias)

(Appears on:AddonStatus)

AddonPhase defines addon phases.


ValueDescription

"Disabled"

"Disabling"

"Enabled"

"Enabling"

"Failed"

AddonSelectorKey (string alias)

(Appears on:SelectorRequirement)

AddonSelectorKey are selector requirement key types.


ValueDescription

"KubeGitVersion"

"KubeVersion"

AddonSpec

(Appears on:Addon)

AddonSpec defines the desired state of an add-on.


FieldDescription
description
string
(Optional)

Addon description.


type
AddonType

Add-on type. The valid value is helm.


helm
HelmTypeInstallSpec
(Optional)

Helm installation spec. It’s processed only when type=helm.


defaultInstallValues
[]AddonDefaultInstallSpecItem

Default installation parameters.


install
AddonInstallSpec
(Optional)

Installation parameters.


installable
InstallableSpec
(Optional)

Addon installable spec. It provides selector and auto-install settings.


cliPlugins
[]CliPlugin
(Optional)

Plugin installation spec.


AddonStatus

(Appears on:Addon)

AddonStatus defines the observed state of an add-on.


FieldDescription
phase
AddonPhase

Add-on installation phases. Valid values are Disabled, Enabled, Failed, Enabling, Disabling.


conditions
[]Kubernetes meta/v1.Condition
(Optional)

Describes the current state of add-on API installation conditions.


observedGeneration
int64
(Optional)

observedGeneration is 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.


AddonType (string alias)

(Appears on:AddonSpec)

AddonType defines the addon types.


ValueDescription

"Helm"

CliPlugin

(Appears on:AddonSpec)

FieldDescription
name
string

Name of the plugin.


indexRepository
string

The index repository of the plugin.


description
string
(Optional)

The description of the plugin.


DataObjectKeySelector

(Appears on:HelmInstallValues)

FieldDescription
name
string

Object name of the referent.


key
string

The key to select.


HelmInstallOptions (map[string]string alias)

(Appears on:HelmTypeInstallSpec)

HelmInstallValues

(Appears on:HelmTypeInstallSpec)

FieldDescription
urls
[]string
(Optional)
configMapRefs
[]DataObjectKeySelector
(Optional)

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


secretRefs
[]DataObjectKeySelector
(Optional)

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


setValues
[]string
(Optional)

Helm install set values. It can specify multiple or separate values with commas(key1=val1,key2=val2).


setJSONValues
[]string
(Optional)

Helm install set JSON values. It can specify multiple or separate values with commas(key1=jsonval1,key2=jsonval2).


HelmJSONValueMapType

(Appears on:HelmValuesMappingItem)

FieldDescription
tolerations
string
(Optional)

tolerations sets the toleration mapping key.


HelmTypeInstallSpec

(Appears on:AddonSpec)

HelmTypeInstallSpec defines the Helm installation spec.


FieldDescription
chartLocationURL
string

A Helm Chart location URL.


installOptions
HelmInstallOptions
(Optional)

installOptions defines Helm release installation options.


installValues
HelmInstallValues
(Optional)

HelmInstallValues defines Helm release installation set values.


valuesMapping
HelmValuesMapping
(Optional)

valuesMapping defines add-on normalized resources parameters mapped to Helm values’ keys.


chartsImage
string
(Optional)

chartsImage defines the image of Helm charts.


chartsPathInImage
string
(Optional)

chartsPathInImage defines the path of Helm charts in the image. It’s used to copy
Helm charts from the image to the shared volume.


HelmValueMapType

(Appears on:HelmValuesMappingItem)

FieldDescription
replicaCount
string
(Optional)

replicaCount sets the replicaCount value mapping key.


persistentVolumeEnabled
string
(Optional)

persistentVolumeEnabled sets the persistent volume enabled mapping key.


storageClass
string
(Optional)

storageClass sets the storageClass mapping key.


HelmValuesMapping

(Appears on:HelmTypeInstallSpec)

FieldDescription
HelmValuesMappingItem
HelmValuesMappingItem

(Members of HelmValuesMappingItem are embedded into this type.)

extras
[]HelmValuesMappingExtraItem
(Optional)

Helm value mapping items for extra items.


HelmValuesMappingExtraItem

(Appears on:HelmValuesMapping)

FieldDescription
HelmValuesMappingItem
HelmValuesMappingItem

(Members of HelmValuesMappingItem are embedded into this type.)

name
string

Name of the item.


HelmValuesMappingItem

(Appears on:HelmValuesMapping, HelmValuesMappingExtraItem)

FieldDescription
valueMap
HelmValueMapType
(Optional)

valueMap define the “key” mapping values. Valid keys are 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
HelmJSONValueMapType
(Optional)

jsonMap defines the “key” mapping values. The valid key is tolerations.
Enum values explained:
"tolerations" sets the toleration mapping key.


resources
ResourceMappingItem
(Optional)

resources sets resources related mapping keys.


InstallableSpec

(Appears on:AddonSpec)

FieldDescription
selectors
[]SelectorRequirement
(Optional)

Add-on installable selectors. If multiple selectors are provided,
all selectors must evaluate to true.


autoInstall
bool

autoInstall defines an add-on should be installed automatically.


LineSelectorOperator (string alias)

(Appears on:SelectorRequirement)

LineSelectorOperator defines line selector operators.


ValueDescription

"Contains"

"DoesNotContain"

"DoesNotMatchRegex"

"MatchRegex"

ResourceMappingItem

(Appears on:HelmValuesMappingItem)

FieldDescription
storage
string
(Optional)

storage sets the storage size value mapping key.


cpu
ResourceReqLimItem
(Optional)

cpu sets CPU requests and limits mapping keys.


memory
ResourceReqLimItem
(Optional)

memory sets Memory requests and limits mapping keys.


ResourceReqLimItem

(Appears on:ResourceMappingItem)

FieldDescription
requests
string
(Optional)

Requests value mapping key.


limits
string
(Optional)

Limits value mapping key.


ResourceRequirements

(Appears on:AddonInstallSpecItem)

FieldDescription
limits
Kubernetes core/v1.ResourceList
(Optional)

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


requests
Kubernetes core/v1.ResourceList
(Optional)

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


SelectorRequirement

(Appears on:AddonDefaultInstallSpecItem, InstallableSpec)

FieldDescription
key
AddonSelectorKey

The selector key. Valid values are KubeVersion, KubeGitVersion.
“KubeVersion” the semver expression of Kubernetes versions, i.e., v1.24.
“KubeGitVersion” may contain distro. info., i.e., v1.24.4+eks.


operator
LineSelectorOperator

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
[]string
(Optional)

An array of string values. It serves as an “OR” expression to the operator.



Generated with gen-crd-api-reference-docs