Custom Resources

The module lifecycle stage: Experimental

The module has requirements for installation

Before enabling the module, you need to allow the use of experimental modules in the deckhouse ModuleConfig. To do this, set the allowExperimentalModules parameter to true.

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

HelmApplicationChart

Scope: Namespaced
Version: v1alpha1

HelmApplicationChart describes a Helm chart discovered in a HelmApplicationRepository.

HelmApplicationChart resources are automatically created and updated by the controller during repository synchronization and are not intended for manual modification.

status

object
- status.conditions
  
  array of objects
  Conditions reflecting the current state of the Helm chart.
  - status.conditions.lastTransitionTime
    
    string
    Time when the condition status last changed.
  - status.conditions.message
    
    string
    Message with additional information about the condition state.
    
    Maximum length: 32768
  - status.conditions.observedGeneration
    
    integer
    Resource generation on which the condition state is based.
    
    Allowed values: 0 <= X
  - status.conditions.reason
    
    string
    Reason for the last change in the condition state.
    
    Length: 1..1024
    
    Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  - status.conditions.status
    
    string
    Condition status.
    
    Allowed values: True, False, Unknown
  - status.conditions.type
    
    string
    Condition type.
    
    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
  URL of the Helm chart icon.
  
  Applicable only to charts from Helm repositories.
- status.observedGeneration
  
  integer
  Latest resource generation processed by the controller.
- status.versions
  
  array of objects
  List of discovered Helm chart versions.
  
  A version is available for installation if unavailableReason is not set. A version that the repository no longer offers stays in the list with unavailableReason: RemovedFromRepository only while a release uses it, and that release keeps working.
  - status.versions.mediaType
    
    string
    OCI media type of the layer containing the Helm chart version.
    
    Populated only for versions from an OCI repository (oci://) with a supported layer type.
  - status.versions.ociRef
    
    string
    OCI reference to the published Helm chart version.
    
    Populated only for a version from a Helm repository if the corresponding repository index entry references an OCI repository instead of a chart archive. Such a version is installed using an internal OCIRepository.
  - status.versions.reexaminationRequired
    
    boolean
    Indicates that the recorded availability of the Helm chart version is outdated and must be rechecked against the repository.
  - status.versions.unavailableMessage
    
    string
    Detailed description of the reason specified in unavailableReason.
  - status.versions.unavailableReason
    
    string
    Reason why the Helm chart version is unavailable for installation.
    
    If the field is not set, the version is available. A release that already uses a version with RemovedFromRepository, or with ResolvePending while the version keeps its recorded mediaType, keeps working.
    
    Allowed values: RemovedFromRepository, UnsupportedMediaType, ResolvePending, InvalidChartReference
  - status.versions.version
    
    string
    Helm chart version.
    
    Minimum length: 1

HelmApplicationRepository

Scope: Namespaced
Version: v1alpha1

HelmApplicationRepository describes a Helm or OCI-compliant repository containing Helm charts that can be referenced by HelmApplication resources from the same namespace.

spec

object
- spec.auth
  
  object
  Credentials for repository authentication.
  - spec.auth.password
    
    string
    Required value
    
    Repository authentication password.
    
    Minimum length: 1
  - spec.auth.username
    
    string
    Required value
    
    Repository authentication username.
    
    Minimum length: 1
- spec.caCertificate
  
  string
  CA certificate in PEM format for verifying the repository TLS certificate.
- spec.insecureSkipVerify
  
  boolean
  Disables verification of the repository TLS certificate.
  
  Applies to an OCI registry only. For a Helm repository served over HTTPS with a self-signed certificate, set caCertificate.
- spec.url
  
  string
  Required value
  
  URL of the Helm or OCI repository.
  
  Supported schemes: http(s):// and oci://. An oci:// URL points to the repository of a single Helm chart, for example oci://registry.example.com/charts/podinfo.
status

object
- status.chartCount
  
  integer
  Number of charts found during the last successful read of the repository, excluding the charts whose name cannot be recorded on a catalog object.
  
  The field is not populated until the first successful read, which distinguishes a repository that has not been read yet from a repository that contains no charts.
- status.conditions
  
  array of objects
  Conditions reflecting the current state of the repository.
  - status.conditions.lastTransitionTime
    
    string
    Time when the condition status last changed.
  - status.conditions.message
    
    string
    Message with additional information about the condition state.
    
    Maximum length: 32768
  - status.conditions.observedGeneration
    
    integer
    Resource generation on which the condition state is based.
    
    Allowed values: 0 <= X
  - status.conditions.reason
    
    string
    Reason for the last change in the condition state.
    
    Length: 1..1024
    
    Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  - status.conditions.status
    
    string
    Condition status.
    
    Allowed values: True, False, Unknown
  - status.conditions.type
    
    string
    Condition type.
    
    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
  Counter of consecutive failed attempts to access the repository, used to determine the delay before the next attempt.
  
  Does not exceed 5: an error that retries cannot fix sets it to 5 at once. Reset after a successful attempt and when the repository specification changes.
- status.lastForceReconcileTime
  
  string
  Time when the last forced reconciliation request was processed.
  
  This value indicates that the request was processed but does not indicate that reconciliation completed successfully. Reconciliation results are reflected in the Ready and Synced conditions.
- status.lastSuccessfulSyncTime
  
  string
  Time of the last successful repository synchronization.
- status.lastSyncedGeneration
  
  integer
  Resource generation that the currently published chart catalog corresponds to.
  
  Updated when a synchronization publishes the catalog without running out of its time budget. Retained if later synchronizations fail or run out of time.
- status.nextSyncTime
  
  string
  Scheduled time of the next repository synchronization attempt.
- status.observedGeneration
  
  integer
  Latest resource generation processed by the controller.
- status.unexaminedVersions
  
  integer
  Number of Helm chart versions offered by the repository that the last synchronization publishing the catalog did not examine because it ran out of time. Retained if later synchronizations fail.
  
  Such versions are examined during the next synchronizations. A value of 0 means that every version offered by the repository has been examined.

HelmApplication

Scope: Namespaced
Version: v1alpha1

HelmApplication describes a Helm release within a single namespace.

The release is deployed in the same namespace as the HelmApplication resource. A HelmApplication cannot be created in a system namespace: default, kube-system, kube-node-lease, kube-public, or a namespace whose name starts with d8-.

The chart is deployed using a ServiceAccount with the permissions of the namespace administrator role. Therefore, namespace administrator permissions are required to create a HelmApplication.

The RoleBinding associated with the ServiceAccount is managed by the module and automatically reconciled to its desired state. Any manual changes to this resource are overwritten.

spec

object
- spec.chart
  
  object
  Required value
  - spec.chart.clusterRepository
    
    string
    Name of the HelmClusterApplicationRepository resource.
    
    The specified repository is used as the Helm chart source.
    
    Length: 1..63
  - spec.chart.name
    
    string
    Required value
    
    Name of the Helm chart in the specified repository (for example, nginx or redis).
    
    Minimum length: 1
  - spec.chart.repository
    
    string
    Name of the HelmApplicationRepository resource in the same namespace.
    
    The specified repository is used as the Helm chart source.
    
    Length: 1..63
  - spec.chart.version
    
    string
    Required value
    
    Helm chart version to install.
    
    Minimum length: 1
- spec.maintenance
  
  string
  Resource reconciliation mode.
  
  When set to NoResourceReconciliation, the controller pauses reconciliation of managed resources, allowing them to be modified manually without the controller overwriting the changes. When set to an empty value (""), the standard reconciliation mode is used.
  
  Allowed values: ‘’, NoResourceReconciliation
- spec.timeout
  
  string
  Time to wait for a Helm operation to complete.
  
  Default: 5m. The value must be greater than zero and must not exceed 2h.
  
  Pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
- spec.values
  
  Custom Helm chart values.
status

object
- status.conditions
  
  array of objects
  Conditions reflecting the current state of the resource.
  - status.conditions.lastTransitionTime
    
    string
    Time when the condition status last changed.
  - status.conditions.message
    
    string
    Message with additional information about the condition state.
    
    Maximum length: 32768
  - status.conditions.observedGeneration
    
    integer
    Resource generation on which the condition state is based.
    
    Allowed values: 0 <= X
  - status.conditions.reason
    
    string
    Reason for the last change in the condition state.
    
    Length: 1..1024
    
    Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  - status.conditions.status
    
    string
    Condition status.
    
    Allowed values: True, False, Unknown
  - status.conditions.type
    
    string
    Condition type.
    
    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.inventory
  
  array of objects
  List of objects deployed by the application’s Helm chart.
  - status.inventory.apiVersion
    
    string
    API group and version of the object (v1 for objects of the core group).
  - status.inventory.kind
    
    string
    Object kind.
  - status.inventory.name
    
    string
    Object name.
  - status.inventory.namespace
    
    string
    Object namespace.
    
    Not set for cluster-scoped objects.
- status.lastAppliedChart
  
  object
  Helm chart used during the last application installation or upgrade.
  - status.lastAppliedChart.clusterRepository
    
    string
    Name of the HelmClusterApplicationRepository resource used during the last application installation or upgrade.
  - status.lastAppliedChart.name
    
    string
    Name of the Helm chart used during the last application installation or upgrade.
  - status.lastAppliedChart.repository
    
    string
    Name of the HelmApplicationRepository resource used during the last application installation or upgrade.
  - status.lastAppliedChart.version
    
    string
    Helm chart version used during the last application installation or upgrade.
- status.lastAppliedValues
  
  Custom Helm chart values used during the last application installation or upgrade.
- status.lastForceReconcileTime
  
  string
  Time when the last forced reconciliation request was processed.
  
  This value indicates that the request was processed but does not indicate that reconciliation completed successfully. Reconciliation results are reflected in the Ready condition.
- status.observedGeneration
  
  integer
  Latest resource generation processed by the controller.