The module lifecycle stage: Experimental

The module has requirements for installation

The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

HelmClusterAddonChart

Scope: Cluster
Version: v1alpha1

HelmClusterAddonChart represents a specific Helm chart discovered within a HelmClusterAddonRepository. These resources are automatically managed during repository synchronization and are immutable to user modifications.
  • apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    object
  • status
    object
    • status.conditions
      array of objects
      Conditions represent the latest available observations of the addon chart state.
      • status.conditions.lastTransitionTime
        string
        lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
      • status.conditions.message
        string
        message is a human readable message indicating details about the transition. This may be an empty string.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

        Length: 1..1024

        Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        string
        status of the condition, one of True, False, Unknown.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        type of condition in CamelCase or in foo.example.com/CamelCase.

        Maximum length: 316

        Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.iconURL
      string
      IconURL is the URL to the Helm chart icon (applicable to Helm Chart repository charts only).
    • status.observedGeneration
      integer
      Generation represents resource generation that was last processed by the controller.
    • status.versions
      array of objects
      Versions lists every chart version the controller has examined. A version is usable when it has no unavailableReason; for an OCI repository a usable version also carries the media type of the layer that holds it.
      • status.versions.mediaType
        string
        MediaType is the OCI media type of the layer that holds this chart version. It is set only for a version of an oci:// repository, and only when the layer is supported: an empty value there means the version cannot be deployed. It stays empty for a version carrying OCIRef — the layer of such an artifact is examined at deploy time and is not recorded here.
      • status.versions.ociRef
        string
        OCIRef is the OCI reference this version is published at, as recorded from the repository index. It is set only for a version of a helm repository whose index entry points at a registry instead of a chart archive; such a version is deployed through an internal OCIRepository even though its repository is a helm one. The registry host and path keep the spelling the index used, and the tag is always explicit: an index entry without one is recorded with its own version as the tag.
      • status.versions.unavailableMessage
        string
        UnavailableMessage carries human readable detail for UnavailableReason.
      • status.versions.unavailableReason
        string
        UnavailableReason explains why this version cannot be deployed. Its absence means the version is usable.

        Allowed values: RemovedFromRepository, UnsupportedMediaType, ResolvePending, InvalidChartReference

      • status.versions.version
        string
        Helm chart version

        Minimal length: 1

HelmClusterAddonRepository

Scope: Cluster
Version: v1alpha1

HelmClusterAddonRepository represents a Helm or OCI-compliant repository containing Helm charts that can be referenced by HelmClusterAddon resources.
  • apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    object
  • spec
    object
    • spec.auth
      object
      Auth contains authentication credentials for the repository.
      • spec.auth.password
        string

        Required value

        Repository authentication password.

        Minimal length: 1

      • spec.auth.username
        string

        Required value

        Repository authentication username.

        Minimal length: 1

    • spec.caCertificate
      string
      CACertificate is the PEM encoded CA certificate for TLS verification.
    • spec.insecureSkipVerify
      boolean
      InsecureSkipVerify disable TLS certificate verification.
    • spec.url
      string

      Required value

      URL of the Helm repository. Supports http(s):// and oci:// protocols.
  • status
    object
    • status.conditions
      array of objects

      Conditions represent the latest available observations of the repository state.

      Ready reports whether the repository is usable: auxiliary resources are in place, the internal source object is healthy and the repository has responded to a catalog read on the current spec. A transient read failure does not flip Ready to False.

      Synced reports whether the chart catalog is up to date.

      Reconciling and Stalled follow the kstatus convention: they are present only while applicable. Reconciling means work is in progress or a retry is scheduled; Stalled means the repository will not recover without a change. While a synchronization is running Reconciling carries the reason Synchronization, or ForceReconcile when the pass was requested through the force reconcile annotation.

      • status.conditions.lastTransitionTime
        string
        lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
      • status.conditions.message
        string
        message is a human readable message indicating details about the transition. This may be an empty string.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

        Length: 1..1024

        Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        string
        status of the condition, one of True, False, Unknown.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        type of condition in CamelCase or in foo.example.com/CamelCase.

        Maximum length: 316

        Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.consecutiveFetchFailures
      integer
      ConsecutiveFetchFailures counts consecutive failures to read from the repository. It drives the retry backoff and resets on the first success.
    • status.lastForceReconcileTime
      string
      LastForceReconcileTime is the time the most recent force reconcile request was processed. It records that the request was acted on, not that it succeeded: the outcome is reported by Ready and Synced.
    • status.lastSuccessfulSyncTime
      string
      LastSuccessfulSyncTime is the last time the chart catalog was fully brought up to date, including creating and pruning chart resources.
    • status.nextSyncTime
      string
      NextSyncTime is the scheduled time of the next synchronization attempt.
    • status.observedGeneration
      integer
      Generation represents resource generation that was last processed by the controller.

HelmClusterAddon

Scope: Cluster
Version: v1alpha1

  • apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    object
  • spec
    object
    • spec.chart
      object

      Required value

      • spec.chart.helmClusterAddonChart
        string

        Required value

        Specifies the name of the Helm chart to be installed from the defined repository (e.g., “ingress-nginx” or “redis”).

        Minimal length: 1

      • spec.chart.helmClusterAddonRepository
        string

        Required value

        Specifies the name of the HelmClusterAddonRepository custom resource that contains the connection details and credentials for the repository where the chart is located.

        Length: 3..63

      • spec.chart.version
        string

        Required value

        Versions holds the HelmClusterAddon chart version.
    • spec.maintenance
      string
      Maintenance specifies the reconciliation strategy for the resource. When set to “NoResourceReconciliation”, the controller will stop updating the underlying resources, allowing for manual intervention or maintenance without the operator overwriting changes. When empty (""), standard reconciliation is active.

      Allowed values: ‘’, NoResourceReconciliation

    • spec.namespace
      string
      Namespace to deploy cluster addon release

      Default: default

      Length: 3..63

    • spec.values
      Values holds the values for this HelmClusterAddon release.
  • status
    object
    • status.conditions
      array of objects

      Conditions represent the latest available observations of the addon state.

      Reconciling is present only while applicable, following the kstatus convention. It carries the reason ForceReconcile while a reconciliation requested through the force reconcile annotation is running.

      • status.conditions.lastTransitionTime
        string
        lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
      • status.conditions.message
        string
        message is a human readable message indicating details about the transition. This may be an empty string.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

        Length: 1..1024

        Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        string
        status of the condition, one of True, False, Unknown.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        type of condition in CamelCase or in foo.example.com/CamelCase.

        Maximum length: 316

        Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.lastAppliedChart
      object
      LastAppliedChart represents the latest chart that triggered addon install or update.
      • status.lastAppliedChart.helmClusterAddonChart
        string
        Specifies the name of the Helm chart to be installed from the defined repository (e.g., “ingress-nginx” or “redis”).
      • status.lastAppliedChart.helmClusterAddonRepository
        string
        Specifies the name of the HelmClusterAddonRepository custom resource that contains the connection details and credentials for the repository where the chart is located.
      • status.lastAppliedChart.version
        string
        Versions holds the HelmClusterAddon chart version.
    • status.lastAppliedValues
      LastAppliedValues represents the latest values that triggered addon install or update.
    • status.lastForceReconcileTime
      string
      LastForceReconcileTime is the time the most recent force reconcile request was processed. It records that the request was acted on, not that it succeeded: the outcome is reported by Ready.
    • status.observedGeneration
      integer
      Generation represents resource generation that was last processed by the controller.