Application

Scope: Namespaced
Version: v1alpha1

Application defines an installed application instance in a namespace.

Example:

apiVersion: deckhouse.io/v1alpha1
kind: Application
metadata:
  name: example
spec:
  maintenance: NoResourceReconciliation
  packageName: console
  packageRepositoryName: deckhouse
  packageVersion: v1.0.0
  releaseChannel: stable
  • spec
    object

    Required value

    Application configuration.

    • spec.maintenance
      string

      Application maintenance mode.

      Supported modes:

      • NoResourceReconciliation: A mode for developing or debugging the application.

        In this mode:

        • Configuration or hook changes are not reconciled, which prevents resources from being updated automatically.
        • Resource monitoring is disabled, which prevents deleted resources from being restored.
        • All the application’s resources are labeled with maintenance.deckhouse.io/no-resource-reconciliation.
        • The ApplicationIsInMaintenanceMode alert is triggered.

      Allowed values: NoResourceReconciliation

      Example:

      maintenance: NoResourceReconciliation
      
    • spec.packageName
      string

      Required value

      Name of the application package to install.

      Example:

      packageName: console
      
    • spec.packageRepositoryName
      string

      Name of the PackageRepository object where the application package is located.

      Example:

      packageRepositoryName: deckhouse
      
    • spec.packageVersion
      string

      Required value

      Version of the application package to install.

      Example:

      packageVersion: v1.0.0
      
    • spec.resourceRequests
      array of objects

      Resource settings, replica counts, and disk sizes for workloads deployed by the application.

      Specified values override the settings provided by the application package. Workloads, containers, and disks not listed in this parameter retain their settings from the package.

      Each workload is identified by a combination of kind (kind) and name (name). Only one entry is allowed for each combination.

      Resource settings, replica count, and disk sizes for a single application workload.

      • spec.resourceRequests.containers
        array of objects

        Compute resources of the workload’s containers.

        If the specified container does not exist in the workload, the entry is ignored.

        Resource settings for a single workload container.

        • spec.resourceRequests.containers.name
          string

          Required value

          Name of the container inside the workload.

          Example:

          name: controller
          
        • spec.resourceRequests.containers.resources
          object

          Container resource requests and limits, or the range within which VerticalPodAutoscaler sets the container’s requests.

          Requests and limits use the same format as the resources field of a Pod container. Supports cpu, memory, and ephemeral-storage.

          Specified values are merged with the settings from the application package separately for each resource. For example, if only memory is specified, the cpu value from the package is retained.

          Resource requests or limits defined in the package cannot be removed. Their values can only be overridden.

          If VerticalPodAutoscaler controls the container’s cpu or memory, a request set for that resource remains fixed. If a cpu or memory limit is set, VPA does not change the container’s limits. The ApplicationVerticalPodAutoscalerPinned alert is triggered if a request or limit is set for a resource controlled by VPA.

          To let VPA choose requests within a range, set min and max instead of cpu and memory requests and limits.

          • spec.resourceRequests.containers.resources.claims
            array of objects

            List of resource claims used by the container.

            Each entry references a resource claim defined in pod.spec.resourceClaims. Requires the DynamicResourceAllocation feature gate to be enabled.

            This field is immutable. It can only be set for containers.

            Resource claim used by the container.

            • spec.resourceRequests.containers.resources.claims.name
              string

              Required value

              Name of a ResourceClaim defined in pod.spec.resourceClaims.

              The referenced claim makes its resources available to the container.

            • spec.resourceRequests.containers.resources.claims.request
              string

              Name of a request defined in the referenced resource claim.

              If specified, only the resources allocated for this request are made available to the container. If omitted, all resources allocated for the claim are made available.

          • spec.resourceRequests.containers.resources.limits
            object

            Maximum amount of compute resources available to the container.

          • spec.resourceRequests.containers.resources.max
            object

            Upper bound of the container’s cpu and memory requests that VerticalPodAutoscaler sets (maxAllowed in its policy for the container).

            Set together with min for the same resources. Within the range, the requests are chosen by VPA, so a container with min and max cannot have cpu or memory requests or limits. A resource bound cannot be less than in min.

            If no VerticalPodAutoscaler of the application sets a resource of the container, for example, because the vertical-pod-autoscaler module is disabled, the container gets min as the request and max as the limit of the resource, and the ApplicationVerticalPodAutoscalerMissing alert is triggered.

            • spec.resourceRequests.containers.resources.max.cpu
              integer or string

              Bound of the cpu request.

              Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

              Example:

              cpu: 250m
              
            • spec.resourceRequests.containers.resources.max.memory
              integer or string

              Bound of the memory request.

              Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

              Example:

              memory: 256Mi
              
          • spec.resourceRequests.containers.resources.min
            object

            Lower bound of the container’s cpu and memory requests that VerticalPodAutoscaler sets (minAllowed in its policy for the container).

            Set together with max for the same resources. Within the range, the requests are chosen by VPA, so a container with min and max cannot have cpu or memory requests or limits. To fix a resource at one value, specify the same value in min and max.

            If no VerticalPodAutoscaler of the application sets a resource of the container, for example, because the vertical-pod-autoscaler module is disabled, the container gets min as the request and max as the limit of the resource, and the ApplicationVerticalPodAutoscalerMissing alert is triggered.

            • spec.resourceRequests.containers.resources.min.cpu
              integer or string

              Bound of the cpu request.

              Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

              Example:

              cpu: 250m
              
            • spec.resourceRequests.containers.resources.min.memory
              integer or string

              Bound of the memory request.

              Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

              Example:

              memory: 256Mi
              
          • spec.resourceRequests.containers.resources.requests
            object

            Minimum amount of compute resources required by the container.

            If this parameter is not specified, the limits value is used if explicitly set. Otherwise, the value is implementation-defined.

            The requests value cannot exceed limits.

      • spec.resourceRequests.kind
        string

        Required value

        Kind of workload for which resource settings are specified.

        Allowed values: Deployment, StatefulSet, DaemonSet, ReplicaSet, Pod, Job, CronJob

        Example:

        kind: Deployment
        
      • spec.resourceRequests.maxReplicas
        integer

        Maximum number of workload replicas for the HorizontalPodAutoscaler that the application deploys for the workload.

        Applies only to Deployment, StatefulSet, and ReplicaSet. Set together with minReplicas. Cannot be set together with replicas: within the range, the number of replicas is chosen by the HorizontalPodAutoscaler.

        If the application does not deploy a HorizontalPodAutoscaler for the workload, the workload runs minReplicas replicas, and the ApplicationHorizontalPodAutoscalerMissing alert is triggered.

        Allowed values: 1 <= X

        Example:

        maxReplicas: 10
        
      • spec.resourceRequests.minReplicas
        integer

        Minimum number of workload replicas for the HorizontalPodAutoscaler that the application deploys for the workload.

        Applies only to Deployment, StatefulSet, and ReplicaSet. Set together with maxReplicas. Cannot be set together with replicas: within the range, the number of replicas is chosen by the HorizontalPodAutoscaler. Cannot be greater than maxReplicas.

        If the application does not deploy a HorizontalPodAutoscaler for the workload, the workload runs minReplicas replicas, and the ApplicationHorizontalPodAutoscalerMissing alert is triggered.

        Allowed values: 1 <= X

        Example:

        minReplicas: 2
        
      • spec.resourceRequests.name
        string

        Required value

        Workload name as specified in the application package.

        Example:

        name: controller
        
      • spec.resourceRequests.replicas
        integer

        Number of workload replicas.

        Applies only to workloads that support replica management: Deployment, StatefulSet, and ReplicaSet. Cannot be set together with minReplicas or maxReplicas.

        If the application deploys a HorizontalPodAutoscaler for the workload, its minReplicas and maxReplicas are set to this value, so the number of replicas does not change, and the ApplicationHorizontalPodAutoscalerPinned alert is triggered. To let HorizontalPodAutoscaler scale the workload, set minReplicas and maxReplicas instead. The value 0 applies only to the workload: HorizontalPodAutoscaler does not scale a workload with no replicas.

        Allowed values: 0 <= X

        Example:

        replicas: 3
        
      • spec.resourceRequests.volumeClaimTemplates
        array of objects

        Disk sizes for the StatefulSet’s volume claim templates.

        Applies only to StatefulSet. Each template is identified by its name, the metadata.name of an entry in spec.volumeClaimTemplates. If the specified template does not exist in the StatefulSet, the entry is ignored.

        The size cannot be less than the size of the existing disks: a disk can only be expanded. Expanding requires the StorageClass of the disks to allow volume expansion (allowVolumeExpansion: true).

        Disk size for a single volume claim template of a StatefulSet.

        • spec.resourceRequests.volumeClaimTemplates.name
          string

          Required value

          Name of the volume claim template in the StatefulSet.

          Example:

          name: data
          
        • spec.resourceRequests.volumeClaimTemplates.storage
          integer or string

          Required value

          Disk size requested from the template for each StatefulSet replica.

          Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

          Example:

          storage: 10Gi
          
    • spec.settings
      object

      Configuration application settings.

    • spec.settingsVersion
      number

      Version of the settings schema the settings are written for. Distinct from packageVersion, which selects the application package.

      Settings of an older version are converted to the latest one the package provides. If not specified, version 1 is used.

    • spec.update
      object

      Application update settings: update mode and update windows.

      If this parameter is not specified, the Manual update mode is used.

      Update notifications cannot be configured for an application: the update.notification settings of the deckhouse module are used.

      Example:

      update:
        mode: Auto
        windows:
        - from: '8:00'
          to: '15:00'
          days:
          - Tue
          - Sat
      
      • spec.update.mode
        string

        Update mode of the application on its release channel.

        • AutoPatch: Automatic update mode for patch versions.

          To change a minor version (for example, from v1.2.* to v1.3.*), confirmation is required.

          A patch version update (for example, from v1.3.1 to v1.3.2) is applied taking into account the update windows, if they are set.

        • Auto: Automatic update mode for all versions.

          Minor version updates (for example, from v1.2.* to v1.3.*) and patch version updates (for example, from v1.3.1 to v1.3.2) are applied taking into account the update windows, if they are set.

        • Manual: Manual update mode for all versions.

          Confirmation is required for updating both minor and patch versions.

        Allowed values: AutoPatch, Auto, Manual

        Examples:

        mode: AutoPatch
        
        mode: Auto
        
        mode: Manual
        
      • spec.update.windows
        array of objects

        List of application update windows.

        Time interval during the day when application updates are allowed.

        • spec.update.windows.days
          array of strings

          Days of the week on which the update window is applied.

          If the parameter is omitted, the update window is applied every day.

          • Element of the array
            string

            Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

        • spec.update.windows.from
          string

          Required value

          Start time of the update window (UTC timezone).

          Should be earlier than the end time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          from: '13:00'
          
        • spec.update.windows.to
          string

          Required value

          End time of the update window (UTC timezone).

          Should be later than the start time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          to: '18:30'
          
  • status
    object

    Current state of the application.

    • status.conditions
      array of objects

      Conditions reflecting the current state of the application.

      Condition reflecting an aspect of the current state of the application.

      • status.conditions.lastTransitionTime
        string

        Required value

        Time when the condition status last changed.

      • status.conditions.message
        string

        Required value

        Message with additional information about the condition.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer

        Value of .metadata.generation for which the condition was set.

        Indicates whether the condition corresponds to the current generation of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string

        Required value

        Programmatic identifier indicating the reason for the last condition status change.

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

        Length: 1..1024

      • status.conditions.status
        string

        Required value

        Condition status.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string

        Required value

        Condition type in CamelCase or in the format foo.example.com/CamelCase.

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

        Maximum length: 316

    • status.currentVersion
      object

      Information about the currently installed application version.

      • status.currentVersion.version
        string

        Installed application version in SemVer format.

    • status.lastAppliedConfiguration
      object

      Application configuration used during the last successful apply.

      Includes user-defined settings and default values defined in the configuration schema.

    • status.summary
      object

      Summary of the application state, including messages and recommendations for the user.

      The controller updates this information during each reconciliation. Each application has exactly one lifecycle state.

      Use this information to display the application state in the web interface. Do not recalculate the state from conditions.

      • status.summary.message
        string

        Description of the current application state.

      • status.summary.state
        string

        Current application lifecycle state.

        Examples:

        state: Pending
        
        state: Failed
        
        state: Updating
        
        state: Configuring
        
        state: Ready
        
        state: Degraded
        
        state: Suspended
        
        state: Deleting
        
      • status.summary.tip
        string

        Recommended action for the current application state.

        May be empty if no additional action is required.

    • status.tracking
      object

      Nelm report on application status.

    • status.update
      object

      Update of the application: the update plan, the version the automatic update moves to next and the notification sent about the pending update.

      Empty before the first version is installed.

      • status.update.automaticVersion
        string

        Version the automatic update installs next. It changes only after the previous one is installed and ready. Empty in the Manual update mode.

      • status.update.notified
        object

        Notification sent about the pending update: the version it announced and when it was sent.

        It is sent to the webhook of the update.notification settings of the deckhouse module. The update is installed no earlier than minimalNotificationTime after the notification. Cleared once a new version is installed or the update is cancelled.

        • status.update.notified.time
          string

          Required value

          Time the notification was sent.

        • status.update.notified.version
          string

          Required value

          Version the notification announced.

      • status.update.plan
        array of strings

        Update path after the automatic version in every update mode. The path follows the compatibility rules to the newest version in the cluster, or to the newest version the rules reach; each step is the newest version from which the end of the path is still reached.

    • status.urls
      array of objects

      Application endpoint URLs obtained from Ingress, HTTPRoute, and ServiceAccount resources in the application chart with the packages.deckhouse.io/application-endpoint-description annotation. A ServiceAccount gives the in-cluster address of the Kubernetes API, https://kubernetes.default.svc/.

      Application endpoint defined by an Ingress, HTTPRoute, or ServiceAccount resource in the application chart.

      • status.urls.description
        string

        Endpoint description from the packages.deckhouse.io/application-endpoint-description annotation.

        The description is empty if the annotation value is "true".

      • status.urls.url
        string

        Required value

        Application endpoint URL.

ApplicationPackage

Short names: ap

Scope: Cluster
Version: v1alpha1

ApplicationPackage defines an application package available for installation.

Example:

apiVersion: deckhouse.io/v1alpha1
kind: ApplicationPackage
metadata:
  name: example
  • status
    object

    Current state of the application package.

    • status.availableRepositories
      array of strings

      List of repository names where the application package is available.

    • status.releaseChannels
      object

      Application package versions associated with release channels in each repository.

      The first-level key is the package repository name, and the second-level key is the release channel name.

    • status.usedBy
      array of objects

      List of applications installed from this package.

      Application installed from the package.

      • status.usedBy.name
        string

        Name of the application instance.

      • status.usedBy.namespace
        string

        Namespace where the application is installed.

      • status.usedBy.repositoryName
        string

        Name of the PackageRepository from which the application was installed.

      • status.usedBy.version
        string

        Package version used by the application.

    • status.usedByCount
      integer

      Number of applications installed from this package.

      Equals the number of entries in usedBy.

ApplicationPackageVersion

Short names: apv

Scope: Cluster
Version: v1alpha1

ApplicationPackageVersion defines a version of an application package.

Example:

apiVersion: deckhouse.io/v1alpha1
kind: ApplicationPackageVersion
metadata:
  name: example
spec:
  packageName: console
  packageRepositoryName: deckhouse
  packageVersion: v1.0.0
  • spec
    object

    Application package version parameters.

    • spec.packageName
      string

      Required value

      Name of the application package.

      Example:

      packageName: console
      
    • spec.packageRepositoryName
      string

      Required value

      Name of the package repository containing the package.

      Example:

      packageRepositoryName: deckhouse
      
    • spec.packageVersion
      string

      Required value

      Version of the application package.

      Example:

      packageVersion: v1.0.0
      
  • status
    object

    Current state of the application package version.

    • status.conditions
      array of objects

      Conditions reflecting the current state of the application package version.

      Condition reflecting an aspect of the current state of the package version.

      • status.conditions.lastTransitionTime
        string

        Required value

        Time when the condition status last changed.

      • status.conditions.message
        string

        Required value

        Message with additional information about the condition.

        May be empty.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer

        Value of .metadata.generation for which the condition was set.

        Indicates whether the condition corresponds to the current generation of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string

        Required value

        Programmatic identifier indicating the reason for the last condition status change.

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

        Length: 1..1024

      • status.conditions.status
        string

        Required value

        Condition status.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string

        Required value

        Condition type in CamelCase or in the format foo.example.com/CamelCase.

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

        Maximum length: 316

    • status.observedGeneration
      integer

      Value of .metadata.generation for which the current status was calculated.

      If the value is lower than the current .metadata.generation, the status does not yet reflect the latest changes to the instance.

      Allowed values: 0 <= X

    • status.packageMetadata
      object

      Application package version metadata, including the description, requirements, disable options, and version compatibility rules.

      • status.packageMetadata.category
        string

        Application package category.

      • status.packageMetadata.changelog
        object

        Information about changes in this package version.

        • status.packageMetadata.changelog.features
          array of strings

          List of new features in this package version.

        • status.packageMetadata.changelog.fixes
          array of strings

          List of bugs fixed in this package version.

      • status.packageMetadata.description
        object

        Localized descriptions of the application package.

        • status.packageMetadata.description.en
          string

          English description of the application package.

        • status.packageMetadata.description.ru
          string

          Russian description of the application package.

      • status.packageMetadata.disableOptions
        object

        Parameters of package disable protection.

        • status.packageMetadata.disableOptions.confirmation
          boolean

          Indicates whether confirmation is required to disable the application package.

        • status.packageMetadata.disableOptions.messages
          object

          Localized messages displayed when confirming package disabling.

          • status.packageMetadata.disableOptions.messages.en
            string

            Disable confirmation message in English.

          • status.packageMetadata.disableOptions.messages.ru
            string

            Disable confirmation message in Russian.

      • status.packageMetadata.licensing
        object

        Application package licensing information for different editions.

        • status.packageMetadata.licensing.editions
          object

          Licensing settings for different application package editions.

          • status.packageMetadata.licensing.editions.<KEY_NAME>
            object

            <KEY_NAME> — item (key) name.

            • status.packageMetadata.licensing.editions.<KEY_NAME>.available
              boolean

              Indicates whether the edition is available for use.

            • status.packageMetadata.licensing.editions.<KEY_NAME>.enabledInBundles
              array of strings

              Bundles in which the package is enabled by default in this edition.

              Not used for application packages.

      • status.packageMetadata.requirements
        object

        System requirements for installing and running the application.

        • status.packageMetadata.requirements.deckhouse
          object

          Required Deckhouse Platform version.

          • status.packageMetadata.requirements.deckhouse.constraint
            string

            Deckhouse Platform version constraint in SemVer format.

        • status.packageMetadata.requirements.kubernetes
          object

          Required Kubernetes version.

          • status.packageMetadata.requirements.kubernetes.constraint
            string

            Kubernetes version constraint in SemVer format.

        • status.packageMetadata.requirements.modules
          object

          Deckhouse Platform module requirements: required and optional dependencies, groups of alternative modules, and groups of incompatible modules.

          • status.packageMetadata.requirements.modules.anyOf
            array of objects

            Groups of alternative modules.

            At least one module in each group must be enabled. If a version constraint is specified for a module, its version must satisfy that constraint.

            These groups do not add edges to the dependency graph.

            Group of alternative modules, at least one of which must be enabled.

            • status.packageMetadata.requirements.modules.anyOf.description
              string

              Human-readable description of the group’s purpose.

            • status.packageMetadata.requirements.modules.anyOf.modules
              array of objects

              Required value

              Alternative modules in the group.

              Module with an optional version constraint in SemVer format.

              If no constraint is specified, any version is allowed.

              • status.packageMetadata.requirements.modules.anyOf.modules.constraint
                string

                Module version constraint in SemVer format.

              • status.packageMetadata.requirements.modules.anyOf.modules.name
                string

                Required value

                Module name.

            • status.packageMetadata.requirements.modules.anyOf.name
              string

              Required value

              Stable identifier used by the scheduler in diagnostics.

          • status.packageMetadata.requirements.modules.conditional
            array of objects

            Optional modules with version constraints.

            The module does not have to be enabled. If it is enabled, its version must satisfy the specified constraint.

            Replaces the deprecated !optional suffix from the v1 requirements format.

            Optional module with a version constraint in SemVer format.

            If no constraint is specified, any version is allowed.

            • status.packageMetadata.requirements.modules.conditional.constraint
              string

              Module version constraint in SemVer format.

            • status.packageMetadata.requirements.modules.conditional.name
              string

              Required value

              Module name.

          • status.packageMetadata.requirements.modules.mandatory
            array of objects

            Modules required for the application to run.

            Each specified module must be enabled. If a version constraint is specified, the module version must satisfy it.

            Required module with an optional version constraint in SemVer format.

            If no constraint is specified, any version is allowed.

            • status.packageMetadata.requirements.modules.mandatory.constraint
              string

              Module version constraint in SemVer format.

            • status.packageMetadata.requirements.modules.mandatory.name
              string

              Required value

              Module name.

          • status.packageMetadata.requirements.modules.noneOf
            array of objects

            Groups of incompatible modules.

            For the application to run, none of the modules in these groups may be enabled with an incompatible version.

            If no version constraint is specified, all versions of the module are considered incompatible. If a constraint is specified, only versions satisfying that constraint are considered incompatible.

            These groups do not add edges to the dependency graph.

            Group of incompatible modules.

            None of the listed modules may be enabled with an incompatible version.

            • status.packageMetadata.requirements.modules.noneOf.description
              string

              Human-readable description of the group’s purpose.

            • status.packageMetadata.requirements.modules.noneOf.modules
              array of objects

              Required value

              Incompatible modules in the group.

              Module with an optional version constraint in SemVer format.

              If no constraint is specified, all versions of the module are considered incompatible.

              • status.packageMetadata.requirements.modules.noneOf.modules.constraint
                string

                Module version constraint in SemVer format defining the range of incompatible versions.

              • status.packageMetadata.requirements.modules.noneOf.modules.name
                string

                Required value

                Module name.

            • status.packageMetadata.requirements.modules.noneOf.name
              string

              Required value

              Stable identifier used by the scheduler in diagnostics.

      • status.packageMetadata.stage
        string

        Life cycle stage of the application package.

        Examples:

        stage: Experimental
        
        stage: Preview
        
        stage: General Availability
        
        stage: Deprecated
        
      • status.packageMetadata.versionCompatibilityRules
        object

        Version compatibility rules for upgrades and downgrades.

        • status.packageMetadata.versionCompatibilityRules.downgrade
          object

          Compatibility rules for downgrading from this application version.

          Default: {"step":{"major":0,"minor":0,"patches":-1}}

          • status.packageMetadata.versionCompatibilityRules.downgrade.step
            object

            Compatibility rule step.

            • status.packageMetadata.versionCompatibilityRules.downgrade.step.major
              integer

              Number of major versions that can be skipped during a downgrade.

              The -1 value removes all limits, 0 forbids the change.

              Defaults to 0.

              Allowed values: -1 <= X

            • status.packageMetadata.versionCompatibilityRules.downgrade.step.minor
              integer

              Number of minor versions that can be skipped during a downgrade.

              The -1 value removes all limits, 0 forbids the change.

              Defaults to 0.

              Allowed values: -1 <= X

            • status.packageMetadata.versionCompatibilityRules.downgrade.step.patches
              integer

              Number of patch versions that can be skipped during a downgrade.

              The -1 value removes all limits, 0 forbids the change.

              Defaults to -1.

              Allowed values: -1 <= X

        • status.packageMetadata.versionCompatibilityRules.upgrade
          object

          Compatibility rules for upgrading to and from this application version.

          Default: {"step":{"major":0,"minor":1,"patches":-1}}

          • status.packageMetadata.versionCompatibilityRules.upgrade.from
            string

            SemVer constraint on the application versions from which the application can be upgraded to this version.

            If specified, the constraint takes priority over the step limits of the version being upgraded from: the application is upgraded to this version only from the versions that satisfy the constraint, regardless of those limits. This applies to the update plan, the automatic update, and a change of spec.packageVersion of the Application. An invalid constraint forbids upgrading to this version.

            If not specified, the step limits of the version being upgraded from apply.

          • status.packageMetadata.versionCompatibilityRules.upgrade.step
            object

            Compatibility rule step.

            • status.packageMetadata.versionCompatibilityRules.upgrade.step.major
              integer

              Number of major versions that can be skipped during an upgrade.

              The -1 value removes all limits, 0 forbids the change.

              Defaults to 0.

              Allowed values: -1 <= X

            • status.packageMetadata.versionCompatibilityRules.upgrade.step.minor
              integer

              Number of minor versions that can be skipped during an upgrade.

              The -1 value removes all limits, 0 forbids the change.

              Defaults to 1.

              Allowed values: -1 <= X

            • status.packageMetadata.versionCompatibilityRules.upgrade.step.patches
              integer

              Number of patch versions that can be skipped during an upgrade.

              The -1 value removes all limits, 0 forbids the change.

              Defaults to -1.

              Allowed values: -1 <= X

    • status.packageSchemas
      object

      OpenAPI schemas for validating user-defined application settings and final values passed to package hooks and templates.

      • status.packageSchemas.settingsConversions
        array of objects

        Conversions that bring settings written for an older settings schema version to the latest one, ordered by version.

        Empty when the package has a single settings schema version.

        PackageSettingsConversion converts settings of the previous settings schema version to Version.

        • status.packageSchemas.settingsConversions.descriptions
          object

          Localized description of the changes in this settings schema version.

          • status.packageSchemas.settingsConversions.descriptions.en
            string

            English description of the conversion.

          • status.packageSchemas.settingsConversions.descriptions.ru
            string

            Russian description of the conversion.

        • status.packageSchemas.settingsConversions.expr
          array of strings

          Required value

          jq expressions applied to the settings in order.

        • status.packageSchemas.settingsConversions.version
          integer

          Required value

          Settings schema version the conversion produces; it converts settings of the previous version.

      • status.packageSchemas.settingsSchema
        object

        OpenAPI v3 schema for validating user-defined application settings in Application.spec.settings.

        The schema is stored as an opaque object because it has a recursive JSON Schema structure. The controller validates it when loading the package metadata.

      • status.packageSchemas.valuesSchema
        object

        OpenAPI v3 schema for validating the final set of values passed to package hooks and templates.

        The final set is formed by merging default values with user-defined application settings.

        The schema is stored as an opaque object because it has a recursive JSON Schema structure. The controller validates it when loading the package metadata.

    • status.usedBy
      array of objects

      List of applications installed from this package version.

      Application installed from the package version.

      • status.usedBy.name
        string

        Name of the application instance.

      • status.usedBy.namespace
        string

        Namespace where the application is installed.

    • status.usedByCount
      integer

      Number of applications installed from this package version.

      Equals the number of entries in usedBy.

      Allowed values: 0 <= X

ClusterConfiguration

Version: deckhouse.io/v1

General parameters of a cluster.

Defines, for example, network and CRI parameters. Some parameters can be changed after the cluster is bootstrapped, during its operation.

To change the ClusterConfiguration resource in a running cluster, run the following command:

d8 system edit cluster-configuration

Example:

apiVersion: deckhouse.io/v1
kind: ClusterConfiguration
podSubnetNodeCIDRPrefix: '24'
podSubnetCIDR: 10.244.0.0/16
serviceSubnetCIDR: 192.168.0.0/16
clusterDomain: k8s.internal
clusterType: Cloud
cloud:
  prefix: k8s-dev
  provider: Yandex
proxy:
  httpProxy: https://user:password@proxy.company.my:8443
  httpsProxy: https://user:password@proxy.company.my:8443
  noProxy:
  - company.my
  • apiVersion
    string

    Required value

    Version of the Deckhouse API.

    Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

  • cloud
    object

    Cloud provider-related settings (if the Cloud clusterType is used).

    • cloud.prefix
      Deprecated
      string

      A prefix of the objects to be created in the cloud.

      Deprecated. Use prefix in the global ModuleConfig instead.

      This field is still used by the installer (dhctl) to name cloud infrastructure at bootstrap and must remain set for cloud clusters; the ModuleConfig value is the source for in-cluster consumers and must match it.

      Is used, for example, to distinguish objects created for different clusters, to configure routing, etc.

      Cloud object names (e.g. disks named <prefix>-kubernetes-data-0) are limited to 63 characters, so the prefix is capped at 45 characters. The effective limit may be lower depending on the provider and the number of master nodes; this is additionally enforced by a bootstrap preflight check.

      Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

      Maximum length: 45

    • cloud.provider
      string

      Required value

      Cloud provider.

      Allowed values: OpenStack, AWS, GCP, Yandex, vSphere, Azure, VCD, Zvirt, Dynamix, Huaweicloud, DVP

  • clusterDomain
    Deprecated
    string

    Deprecated. Use clusterDomain in the network section of the control-plane-manager ModuleConfig instead.

    Cluster domain (used for local routing).

    Please note: the domain must not match the domain used in the DNS name template in the publicDomainTemplate parameter. For example, you cannot set clusterDomain: cluster.local and publicDomainTemplate: %s.cluster.local at the same time.

    If you need to change a parameter in a running cluster, it is recommended to use instructions

    The field still works, but it will be removed in a future release. Until the value is moved to the ModuleConfig, the cluster reports the D8ObsoleteClusterDomainInClusterConfiguration alert. Remove it here only after the ModuleConfig carries the domain.

  • clusterType
    string

    Required value

    Type of the cluster infrastructure:

    • Static — a cluster on bare metal (physical servers) or virtual machines. In the case of virtual machines, it is assumed that Deckhouse doesn’t have access to the API for managing virtual machines (they are managed by the administrator using the usual cloud infrastructure tools);
    • Cloud — a cluster deployed on the resources of a cloud infrastructure. This type implies that Deckhouse has access to the cloud infrastructure API for managing virtual machines.

    Allowed values: Cloud, Static

  • defaultCRI
    string

    The container runtime type that used on cluster nodes (NodeGroups) by default.

    If the value NotManaged is used, then Deckhouse does not manage the container runtime (and doesn’t install it). In this case, it is necessary to use images for NodeGroups on which the container runtime is already installed.

    If ContainerdV2 is set, CgroupsV2 will be used (providing improved security and resource management). To use ContainerdV2 as the container runtime, cluster nodes must meet the following requirements:

    • Support for CgroupsV2.
    • Linux kernel version 5.8 or newer, except for the ranges 6.12.0–6.12.28 or 6.14.0–6.14.6 (these versions are affected by CVE-2025-37999 in EROFS).
    • Systemd version 244 or newer.
    • Support for erofs kernel module.

    Default: Containerd

    Allowed values: Containerd, ContainerdV2, NotManaged

  • encryptionAlgorithm
    Deprecated
    string

    Deprecated. Use encryptionAlgorithm in the control-plane-manager ModuleConfig instead.

    When the ModuleConfig field is set, it takes precedence over this field.

    Starting from version 1.31, kubeadm use the specified asymmetric encryption algorithm when generating keys and certificates for the following control-plane components:

    • apiserver
    • apiserver-kubelet-client
    • apiserver-etcd-client
    • front-proxy-client
    • etcd-server
    • etcd-peer
    • etcd-healthcheck-client

    Certificates for the components listed above will be reissued using the selected algorithm and key length.

    Warning. When reissuing certificates, the root certificate (CA) is not rotated. The root certificate is created with the selected algorithm only during the initial cluster bootstrap.

    Allowed values: RSA-2048, RSA-3072, RSA-4096, ECDSA-P256

  • kind
    string

    Required value

    Allowed values: ClusterConfiguration

  • kubernetesVersion
    Deprecated
    string

    Deprecated. Use kubernetesVersion in the control-plane-manager ModuleConfig instead (d8 k edit mc control-plane-manager).

    The cluster Kubernetes version is resolved in the following order: kubernetesVersion parameter in the control-plane-manager ModuleConfig, then this field, then the version the current DP release defaults to. The ModuleConfig setting wins whenever it is set, Default included.

    This field is optional. While it pins a version and the kubernetesVersion in the control-plane-manager ModuleConfig setting is unset, this field is what decides the cluster version. The D8ObsoleteKubernetesVersionFieldInClusterConfiguration alert appears in the cluster simply because the field is present — including when the ModuleConfig setting already decides the version — and clears it once the field is removed.

    Do not change this field in a running cluster to upgrade or downgrade Kubernetes — change kubernetesVersion in the control-plane-manager ModuleConfig instead.

    If Automatic is specified, then the control plane version is used, which is considered stable at the moment. If the stable version of control plane is less than the maximum version that has ever been installed in the cluster, more than 1 minor version, then the version of the cluster will not be changed. The version may change when the minor version of the Deckhouse release is changed (see a corresponding release message).

    Allowed values: 1.33, 1.34, 1.35, 1.36, 1.37, Automatic

  • podSubnetCIDR
    Deprecated
    string

    Deprecated. Use podSubnetCIDR in the network section of the control-plane-manager ModuleConfig instead.

    Address space of the cluster’s Pods.

    Must be an address with a prefix length, for example 10.111.0.0/16. A value written without one is rejected when the configuration is loaded.

    Warning! Changing this parameter in a running cluster is extremely dangerous and can lead to complete cluster failure. The change is blocked by default. To bypass this protection, use dhctl config edit cluster-configuration --yes-i-am-sane-and-i-understand-what-i-am-doing command. However, it is strongly recommended to recreate the cluster instead of changing this parameter. See documentation for details.

    Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

  • podSubnetNodeCIDRPrefix
    Deprecated
    string

    Deprecated. Use podSubnetNodeCIDRPrefix in the network section of the control-plane-manager ModuleConfig instead.

    The prefix size of the Pod network allocated to each node.

    This parameter determines how many IP addresses are available for Pods on each individual node. For example, if podSubnetCIDR: 10.111.0.0/16 and podSubnetNodeCIDRPrefix: "24", each node will receive a /24 subnet (e.g., 10.111.0.0/24, 10.111.1.0/24, etc.), providing up to 254 IP addresses per node (253 usable for Pods, accounting for network and broadcast addresses).

    Calculation examples:

    • With /16 network and /24 prefix: maximum 256 nodes (2^(24-16) = 256)
    • With /16 network and /25 prefix: maximum 512 nodes, but only 126 IPs per node
    • Each Pod network IP can support up to 2 Pods (one running + one terminating)

    Warning! Changing this parameter in a running cluster is extremely dangerous and can lead to complete cluster failure. The change is blocked by default. To bypass this protection, use dhctl config edit cluster-configuration --yes-i-am-sane-and-i-understand-what-i-am-doing command. However, it is strongly recommended to recreate the cluster instead of changing this parameter. See documentation for details.

    If the parameter is set in neither place, 24 is used.

  • proxy
    object

    Available in editions: BE, SE, SE+, Ultimate/EE

    Global proxy setup (mainly for working in air-gapped environments).

    The parameters described in this section will be translated into the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY for all cluster nodes and Deckhouse components. This will result in HTTP(S) requests (curl, git, registry, etc.) to all resources not listed in the noProxy parameter being made through a proxy. Note that the podSubnetCIDR and serviceSubnetCIDR subnets, as well as the clusterDomain domain are added to noProxy automatically.

    Caution! To avoid using proxies in requests between pods and services located in the cluster node network, make sure you list all the host subnets in the noProxy parameter.

    • proxy.httpProxy
      string

      Available in editions: BE, SE, SE+, Ultimate/EE

      Proxy URL for HTTP requests.

      If necessary, specify the proxy server’s username, password, and port.

      Pattern: ^https?://([!*'();&=+$,/?%#\[\]0-9a-zA-Z\.\-\_]+(\:[!*'();:@&=+$,/?%#\[\]0-9a-zA-Z\.\-\_]+)?@)?[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?$

      Examples:

      httpProxy: http://proxy.company.my
      
      httpProxy: https://user:password@proxy.company.my:8443
      
      httpProxy: https://DOMAIN%5Cuser:password@proxy.company.my:8443
      
      httpProxy: https://user%40domain.local:password@proxy.company.my:8443
      
    • proxy.httpsProxy
      string

      Available in editions: BE, SE, SE+, Ultimate/EE

      Proxy URL for HTTPS requests.

      If necessary, specify the proxy server’s username, password, and port.

      Pattern: ^https?://([!*'();&=+$,/?%#\[\]0-9a-zA-Z\.\-\_]+(\:[!*'();:@&=+$,/?%#\[\]0-9a-zA-Z\.\-\_]+)?@)?[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?$

      Examples:

      httpsProxy: http://proxy.company.my
      
      httpsProxy: https://user:password@proxy.company.my:8443
      
      httpsProxy: https://DOMAIN%5Cuser:password@proxy.company.my:8443
      
      httpsProxy: https://user%40domain.local:password@proxy.company.my:8443
      
    • proxy.noProxy
      array of strings

      Available in editions: BE, SE, SE+, Ultimate/EE

      List of no proxy IP and domain entries.

      For wildcard domains, use a domain name with a dot prefix, e.g., “.example.com”.

      Caution. If the cluster is supposed to have pods interacting with services located in the cluster node network, then specify the list of subnets that are used on the nodes.

      • Element of the array
        string

        Pattern: ^[a-z0-9\-\./]+$

  • serviceSubnetCIDR
    Deprecated
    string

    Deprecated. Use serviceSubnetCIDR in the network section of the control-plane-manager ModuleConfig instead.

    Address space of the cluster’s services.

    Must be an address with a prefix length, for example 10.222.0.0/16. A value written without one is rejected when the configuration is loaded.

    Warning! Changing this parameter in a running cluster is extremely dangerous and can lead to complete cluster failure. The change is blocked by default. To bypass this protection, use dhctl config edit cluster-configuration --yes-i-am-sane-and-i-understand-what-i-am-doing command. However, it is strongly recommended to recreate the cluster instead of changing this parameter. See documentation for details.

    Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

CNIMigration

Short names: cnim

Scope: Cluster
Version: v1alpha1

Defines the configuration for CNI migration.

  • spec
    object

    Defines the desired state of CNI migration.

    • spec.targetCNI
      string

      The target CNI to migrate to.

  • status
    object

    Defines the observed state of CNI migration.

    • status.conditions
      array of objects

      Reflect the state of the migration as a whole.

      • status.conditions.lastTransitionTime
        string

        Required value

      • status.conditions.message
        string

        Required value

      • status.conditions.reason
        string

        Required value

      • status.conditions.status
        string

        Required value

      • status.conditions.type
        string

        Required value

    • status.currentCNI
      string

      The detected CNI from which the switch is being made.

    • status.failedSummary
      array of objects

      Details about nodes that failed the migration.

      • status.failedSummary.node
        string
      • status.failedSummary.reason
        string
    • status.nodesFailed
      integer

      The number of nodes where an error occurred.

    • status.nodesSucceeded
      integer

      The number of nodes that have successfully completed the current phase.

    • status.nodesTotal
      integer

      The total number of nodes involved in the migration.

    • status.phase
      string

      The current step of the migration process.

CNINodeMigration

Short names: cninm

Scope: Cluster
Version: v1alpha1

Defines the configuration for CNI migration on a specific node.

  • spec
    object

    Defines the desired state of CNI migration on a node.

  • status
    object

    Defines the observed state of CNI migration on a node.

    • status.conditions
      array of objects

      A list of conditions for this migration.

      • status.conditions.lastTransitionTime
        string

        Required value

      • status.conditions.message
        string

        Required value

      • status.conditions.reason
        string

        Required value

      • status.conditions.status
        string

        Required value

      • status.conditions.type
        string

        Required value

    • status.phase
      string

      The current phase of the migration on the node.

DeckhouseRelease

Scope: Cluster
Version: v1alpha1

Determines the state and parameters for applying a specific release (version) of the Deckhouse Platform (DP) in the cluster.

DeckhouseRelease objects are automatically created by DP upon the discovery of new DP versions on the selected release channel. Modifying DeckhouseRelease enables the management of the process for applying the corresponding DP version. More details about configuring DP updates can be found in the documentation.

The current versions of DP and modules by release channels can be found at releases.deckhouse.ru.

  • approved
    boolean

    Allows or disables manual updates.

    Used only if the deckhouse module is configured for manual update mode (update.mode parameter is set to Manual). Ignored if the update mode is set to Auto or AutoPatch.

    For more information on confirming manual updates, refer to the documentation.

    Default: false

  • spec
    object

    Required value

    • spec.applyAfter
      string

      Marks release as a part of canary-release. This release will be delayed until the specified time. If the release is waiting to be applied, check .status.message for the reason.

    • spec.changelog
      object

      A structure containing a list of DP changes (and modules included in the DP) of the release.

      For more information about DP release changelogs, refer to Updating.

    • string

      Link to site with full changelog for this release.

    • spec.disruptions
      Deprecated
      array of strings

      Disruptive changes in the release.

    • spec.requirements
      object

      A structure containing a list of requirements for installing the release. It is used by the DP core. If the requirements are not met, the release may be skipped or blocked from installation.

      Reports on unmet requirements can be found in the field .status.message of the DeckhouseRelease object.

    • spec.version
      string

      Required value

      DP version.

      Example:

      version: v1.73.2
      
  • status
    object
    • status.approved
      boolean

      The status of the release’s readiness for deployment. It makes sense only for Manual updates (update.mode: Manual).

    • status.message
      string

      Detailed status or error message.

    • status.phase
      string

      Current status of the release.

      Allowed values: Pending, Deployed, Outdated, Suspended, Superseded, Skipped

    • status.transitionTime
      string

      Time of release status change.

InitConfiguration

Version: deckhouse.io/v1

Deckhouse configuration to start after installation.

Example:

apiVersion: deckhouse.io/v1
kind: InitConfiguration
deckhouse:
  imagesRepo: nexus.company.my/deckhouse/ee
  registryDockerCfg: eyJhdXRocyI6IHsgIm5leHVzLmNvbXBhbnkubXkiOiB7InVzZXJuYW1lIjoibmV4dXMtdXNlciIsInBhc3N3b3JkIjoibmV4dXMtcEBzc3cwcmQiLCJhdXRoIjoiYm1WNGRYTXRkWE5sY2pwdVpYaDFjeTF3UUhOemR6QnlaQW89In19fQo=
  registryScheme: HTTPS
  registryCA: |
    -----BEGIN CERTIFICATE-----
    ...
    -----END CERTIFICATE-----
  • apiVersion
    string

    Required value

    Version of the Deckhouse API.

    Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

  • deckhouse
    Deprecated
    object

    Required value

    Initial parameters required to install Deckhouse.

    • deckhouse.devBranch
      Deprecated
      string

      The parameter is used for development needs. Will be replaced with the CLI-tools.

    • deckhouse.imagesRepo
      string

      Address of a container registry with Deckhouse images.

      Specify it if Deckhouse Enterprise Edition edition or third-party registry (e.g. proxy server in a closed environment) is used.

      The address matches the edition of Deckhouse used. The public container registry address for Deckhouse Enterprise Edition is registry.deckhouse.io/deckhouse/ee.

      Default: registry.deckhouse.io/deckhouse/ce

      Pattern: ^[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?(\/[0-9a-zA-Z\.\-\_\/]+)?$

    • deckhouse.registryCA
      string

      Root CA certificate to validate the container registry’s HTTPS certificate (if self-signed certificates are used).

    • deckhouse.registryDockerCfg
      string

      A Base64-encoded string from the Docker client configuration file (in Linux it is usually $HOME/.docker/config.json), for accessing a third-party container registry.

      For example, to access the container registry registry.company.my under the user username with the password password it will be eyJhdXRocyI6eyJyZWdpc3RyeS5jb21wYW55Lm15Ijp7ImF1dGgiOiJkWE5sY201aGJXVTZjR0Z6YzNkdmNtUT0ifX19Cg== (string {"auths":{"registry.company.my":{"auth":"dXNlcm5hbWU6cGFzc3dvcmQ="}}} in Base64).

      Default:

      Example:

      registryDockerCfg: eyJhdXRocyI6IHsgInJlZ2lzdHJ5LmRlY2tob3VzZS5pbyI6IHt9fX0=
      
    • deckhouse.registryScheme
      string

      Registry access scheme (HTTP or HTTPS).

      Default: HTTPS

      Allowed values: HTTP, HTTPS

  • kind
    string

    Required value

    Allowed values: InitConfiguration

Module

Scope: Cluster

  • v1beta1
  • v1alpha1

Module represents a module instance managed via the package system.

  • spec
    object

    Required value

    Spec defines the behavior of a Module.

    • spec.enabled
      boolean

      Enables or disables the module. Unset leaves the decision to the platform.

    • spec.maintenance
      string

      Defines the module maintenance mode.

      • NoResourceReconciliation: A mode for developing or tweaking the module.

        In this mode:

        • Configuration or hook changes are not reconciled, which prevents resources from being updated automatically.
        • Resource monitoring is disabled, which prevents deleted resources from being restored.
        • All the module’s resources are labeled with maintenance.deckhouse.io/no-resource-reconciliation.
        • The ModuleIsInMaintenanceMode alert is triggered.

      Allowed values: NoResourceReconciliation

    • spec.packageRepositoryName
      string

      Name of the repository where the package is located. If not specified, the default repository is used.

      Example:

      packageRepositoryName: deckhouse
      
    • spec.packageVersion
      string

      Required value

      Version of the module package to install.

      Example:

      packageVersion: v1.0.0
      
    • spec.releaseChannel
      string

      Release channel for the module package.

    • spec.settings
      object

      Configuration settings for the module.

    • spec.settingsVersion
      number

      Version of the settings schema. Distinct from packageVersion, which selects the module package.

    • spec.update
      object

      Module update settings: update mode, update windows, and blocking updates when alerts are present.

      If this parameter is not specified, the Deckhouse Platform update settings are applied.

      Example:

      update:
        mode: Auto
        windows:
        - from: '8:00'
          to: '15:00'
          days:
          - Tue
          - Sat
        blockOnAlerts:
          enabled: true
          severity: 2
      
      • spec.update.blockOnAlerts
        object

        Settings for blocking module updates while there are alerts in the cluster.

        • spec.update.blockOnAlerts.enabled
          boolean

          Indicates whether to block module updates when the cluster has alerts with a severity level equal to or higher than the value specified in the severity parameter.

        • spec.update.blockOnAlerts.severity
          integer

          Alert severity level at which updates are blocked.

          Set as a value from 0 to 9, where 0 is the highest severity and 9 is the lowest.

          Default: 4

          Allowed values: 0 <= X <= 9

      • spec.update.mode
        string

        Update mode of the module on its release channel.

        • AutoPatch: Automatic update mode for patch versions.

          To change a minor version (for example, from v1.2.* to v1.3.*), confirmation is required.

          A patch version update (for example, from v1.3.1 to v1.3.2) is applied taking into account the update windows, if they are set.

        • Auto: Automatic update mode for all versions.

          Minor version updates (for example, from v1.2.* to v1.3.*) and patch version updates (for example, from v1.3.1 to v1.3.2) are applied taking into account the update windows, if they are set.

        • Manual: Manual update mode for all versions.

          Confirmation is required for updating both minor and patch versions.

        Default: AutoPatch

        Allowed values: AutoPatch, Auto, Manual

        Examples:

        mode: AutoPatch
        
        mode: Auto
        
        mode: Manual
        
      • spec.update.windows
        array of objects

        List of module update windows.

        Time interval during the day when module updates are allowed.

        • spec.update.windows.days
          array of strings

          Days of the week on which the update window is applied.

          If the parameter is omitted, the update window is applied every day.

          • Element of the array
            string

            Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

        • spec.update.windows.from
          string

          Required value

          Start time of the update window (UTC timezone).

          Should be earlier than the end time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          from: '13:00'
          
        • spec.update.windows.to
          string

          Required value

          End time of the update window (UTC timezone).

          Should be later than the start time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          to: '18:30'
          
  • status
    object

    Status of a Module.

    • status.conditions
      array of objects

      Conditions reflecting the latest observations of the module state.

      Condition contains details for one aspect of the current state of this API Resource.

      • status.conditions.lastTransitionTime
        string

        Required value

        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

        Required value

        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

        Required value

        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.

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

        Length: 1..1024

      • status.conditions.status
        string

        Required value

        status of the condition, one of True, False, Unknown.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string

        Required value

        type of condition in CamelCase or in foo.example.com/CamelCase.

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

        Maximum length: 316

    • status.currentVersion
      object

      Information about the currently installed version.

      • status.currentVersion.channel
        string

        Release channel from which the version was installed.

      • status.currentVersion.version
        string

        Semantic version of the installed module.

    • status.enabled
      boolean

      Reports whether the module is enabled: spec.enabled resolved against the edition bundle, the enabled-script and the module dependencies. It can differ from spec.enabled — an explicitly enabled module stays disabled while a module it requires is disabled. Absent until the first decision.

    • status.lastAppliedConfiguration
      object

      LastAppliedConfiguration is the effective settings (user configuration merged with config-schema defaults) that drove the most recent successful apply.

    • status.summary
      object

      Summary aggregates the high-level user-facing state, message and resolution hint for the module. The controller always populates it on reconcile — every module maps to exactly one lifecycle state — so it is the single source of truth for the UI; clients should not re-derive these values from the conditions. The pointer leaves it absent only before the first status computation.

      • status.summary.message
        string

        Message is a human-readable description of the current state.

      • status.summary.state
        string

        State is the high-level lifecycle state observed for the module. Always one of: Pending, Failed, Updating, Configuring, Ready, Degraded, Suspended, Deleting.

        Examples:

        state: Pending
        
        state: Failed
        
        state: Updating
        
        state: Configuring
        
        state: Ready
        
        state: Degraded
        
        state: Suspended
        
        state: Deleting
        
      • status.summary.tip
        string

        Tip is a human-readable instruction on how to resolve the current state. Empty when no action is required.

    • status.tracking
      object

      Nelm tracking.

Describes the module’s status in the cluster. The Module object is created automatically after configuring the ModuleSource and successfully completing synchronization.

  • properties
    object
    • properties.accessibility
      object

      Module accessibility settings.

      • properties.accessibility.editions
        object

        Module operation settings in Deckhouse editions.

        • properties.accessibility.editions.<KEY_NAME>
          object

          <KEY_NAME> — item (key) name.

          • properties.accessibility.editions.<KEY_NAME>.available
            boolean
          • properties.accessibility.editions.<KEY_NAME>.enabledInBundles
            array of strings
    • properties.availableSources
      array of strings

      Available sources for downloading the module.

    • properties.critical
      boolean

      Indicates whether the module critical or not.

    • properties.disableOptions
      object

      Parameters of module disable protection.

      • properties.disableOptions.confirmation
        boolean
      • properties.disableOptions.message
        string

        Deprecated: use Messages with localized ru/en fields instead.

      • properties.disableOptions.messages
        object

        Warning messages displayed when disabling the module, localized for different languages. If a message for the selected language is not defined, the value of the message field is used instead.

        • properties.disableOptions.messages.en
          string
        • properties.disableOptions.messages.ru
          string
    • properties.exclusiveGroup
      string

      Indicates the group where only one module can be active at a time.

    • properties.namespace
      string

      Module namespace.

    • properties.releaseChannel
      string

      Module release channel.

    • properties.requirements
      object

      Module dependencies, a set of requirements that must be met for Deckhouse Kubernetes Platform (DKP) to run the module.

      • properties.requirements.bootstrapped
        string

        Required cluster installation status (for built-in DKP modules only).

      • properties.requirements.deckhouse
        string

        Required Deckhouse version.

      • properties.requirements.kubernetes
        string

        Required Kubernetes version.

      • properties.requirements.modules
        object

        A list of other enabled modules required for the module.

    • properties.source
      string

      Source the module was downloaded from (otherwise will be blank).

    • properties.stage
      string

      Current stage of the module lifecycle.

    • properties.subsystems
      array of strings

      Module subsystems.

    • properties.updatePolicy
      string

      Module update policy.

    • properties.version
      string

      Module version.

    • properties.weight
      integer

      Module weight (priority).

  • spec
    object
  • status
    object
    • status.conditions
      array of objects
      • status.conditions.lastProbeTime
        string
      • status.conditions.lastTransitionTime
        string
      • status.conditions.message
        string
      • status.conditions.reason
        string
      • status.conditions.status
        string
      • status.conditions.type
        string
    • status.hooksState
      string

      Hooks status report.

    • status.phase
      string

      Module phase.

      Allowed values: Unavailable, Available, Downloading, DownloadingError, Reconciling, Installing, HooksDisabled, WaitSyncTasks, Downloaded, Conflict, Ready, Error

      Examples:

      phase: Unavailable
      
      phase: Available
      
      phase: Downloading
      
      phase: DownloadingError
      
      phase: Reconciling
      
      phase: Installing
      
      phase: HooksDisabled
      
      phase: WaitSyncTasks
      
      phase: Downloaded
      
      phase: Conflict
      
      phase: Ready
      
      phase: Error
      

ModuleConfig

Short names: mc

Scope: Cluster
Version: v1alpha1

Defines the configuration of the Deckhouse Platform module (module parameters). The name of the ModuleConfig resource must match the name of the module (for example, control-plane-manager for the control-plane-manager module).

Example:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: module-1
spec:
  enabled: true
  settings: {}
  version: 1
  • spec
    object

    Required value

    • spec.enabled
      boolean

      Enables or disables the module.

      Example:

      enabled: false
      
    • spec.maintenance
      string

      Defines the module maintenance mode.

      • NoResourceReconciliation: A mode for developing or tweaking the module.

        In this mode:

        • Configuration or hook changes are not reconciled, which prevents resources from being updated automatically.
        • Resource monitoring is disabled, which prevents deleted resources from being restored.
        • All the module’s resources are labeled with maintenance: NoResourceReconciliation.
        • The ModuleIsInMaintenanceMode alert is triggered.

      Allowed values: NoResourceReconciliation

      Example:

      maintenance: NoResourceReconciliation
      
    • spec.settings
      object

      Module settings.

    • spec.source
      string

      The source of the module it provided by one (otherwise empty).

    • spec.updatePolicy
      string

      Module update policy.

      Example:

      updatePolicy: test-alpha
      
    • spec.version
      number

      Version of settings schema.

      Example:

      version: 1
      
  • status
    object
    • status.message
      string

      Additional information

    • status.version
      string

      Version of settings schema in use

ModulePullOverride

Short names: mpo

Scope: Cluster

  • v1alpha2
  • v1alpha1

Defines the resource configuration for downloading specific versions of Deckhouse modules.

Caution. This resource is intended for development and debugging environments only. Using it in production clusters is not recommended. Support for the resource might be removed in future Deckhouse Platform versions.

  • spec
    object

    Required value

    • spec.imageTag
      string

      Required value

      Module container image tag, which will be pulled.

    • spec.rollback
      boolean

      Indicates whether the module release should be rollback after deleting mpo.

      Default: false

    • spec.scanInterval
      string

      Scan interval for checking the image digest. If the digest changes, the module is updated. Supported units: h, m, s.

      Default: 15s

      Pattern: ^(\d+h)?(\d+m)?(\d+s)?$

  • status
    object
    • status.imageDigest
      string

      Digest of the module image.

    • status.message
      string

      Details of the resource status.

    • status.updatedAt
      string

      When the module was last updated.

    • status.weight
      integer

      Module weight.

Deprecated resource. Support for the resource might be removed in a later release.

Defines the configuration.

  • spec
    object

    Required value

    • spec.imageTag
      string

      Required value

      Module container image tag, which will be pulled.

    • spec.rollback
      boolean

      Indicates whether the module release should be rollback after deleting ModulePullOverride.

      Default: false

    • spec.scanInterval
      string

      Scan interval for checking the image digest. If the digest changes, the module is updated. Supported units: h, m, s.

      Default: 15s

      Pattern: ^(\d+h)?(\d+m)?(\d+s)?$

    • spec.source
      string

      Required value

      Reference to the ModuleSource with the module.

  • status
    object
    • status.imageDigest
      string

      Digest of the module image.

    • status.message
      string

      Details of the resource status.

    • status.updatedAt
      string

      When the module was last updated.

    • status.weight
      integer

      Module weight.

ModuleRelease

Short names: mr

Scope: Cluster
Version: v1alpha1

Defines the configuration for a Deckhouse release.

ModuleRelease resources are created by Deckhouse.

  • spec
    object

    Required value

    • spec.applyAfter
      string

      Time until which the release will be delayed.

    • spec.changelog
      object

      Release’s changelog for the module.

    • spec.moduleName
      string

      Required value

      Module name.

    • spec.requirements
      object

      Release dependencies, a set of requirements that must be met for Deckhouse Platform to run the module release.

      • spec.requirements.deckhouse
        string

        Required Deckhouse version.

      • spec.requirements.kubernetes
        string

        Required Kubernetes version.

      • spec.requirements.modules
        object

        A list of other modules required for the module release. Ensure the modules are enabled.

    • spec.update
      object

      Optional transition rules.

      • spec.update.versions
        array of objects

        List of from→to transition rules that allow skipping step-by-step updates. If the current installed module version (status Deployed) is not lower than from, and the cluster has a release whose version matches to, the controller will skip intermediate releases and update the module to the version from to. The to value can specify a minor line (X.Y — the latest available X.Y.Z will be selected). The rule is specified in the constrained release — the one whose version matches to.

        • spec.update.versions.from
          string

          Required value

          The minimum version from which the transition is allowed (format X.Y).

        • spec.update.versions.to
          string

          Required value

          The end version of the range — a minor line (X.Y).

    • spec.version
      string

      Required value

      Module version.

      Example:

      version: v1.0.0
      
    • spec.weight
      integer

      Module weight (priority).

  • status
    object
    • status.approved
      boolean

      Status indicating that the release is ready for deployment. For the Manual update mode only (update.mode: Manual).

    • status.message
      string

      Detailed status or error message.

    • status.phase
      string

      Current status of the release.

      Allowed values: Pending, Deployed, Superseded, Suspended, Skipped, Terminating

    • status.pullDuration
      string

      Module loading duration.

    • status.size
      integer

      Size of the module image.

    • status.transitionTime
      string

      Time of release status change.

ModuleSettingsDefinition

Scope: Cluster
Version: v1alpha1

It displays module settings. Defines a list of module settings versions.

  • spec
    object

    Required value

    Specification of the module settings.

    • spec.versions
      array of objects

      List of module settings versions. Each version includes a name and a schema.

      • spec.versions.conversions
        array of objects

        List of conversion rules for this version.

        A single conversion rule with expressions and descriptions.

        • spec.versions.conversions.descriptions
          object

          Localized descriptions of the conversion.

          • spec.versions.conversions.descriptions.en
            string

            English description of the conversion.

          • spec.versions.conversions.descriptions.ru
            string

            Russian description of the conversion.

        • spec.versions.conversions.expr
          array of strings

          Array of jq expressions to transform settings.

      • spec.versions.name
        string

        Required value

        Module settings version.

      • spec.versions.schema
        object

        Settings schema for the given module version.

ModuleSource

Short names: ms

Scope: Cluster
Version: v1alpha1

Defines the configuration of a source of Deckhouse modules.

For more information about installing the module from the source, see the section “Running the module in the DP cluster”.

Example:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleSource
metadata:
  name: example
spec:
  registry:
    repo: registry.example.io/modules-source
    dockerCfg: "<base64 encoded credentials>"
  • spec
    object

    Required value

    • spec.registry
      object

      Required value

      • spec.registry.ca
        string

        Root CA certificate (PEM format) to validate the registry’s HTTPS certificate (if self-signed certificates are used).

        Creating a ModuleSource resource with the CA certificate spec will cause the container to restart on all nodes.

      • spec.registry.dockerCfg
        string

        Container registry access token in Base64. If using anonymous access to the container registry, do not fill in this field.

      • spec.registry.repo
        string

        Required value

        URL of the container registry.

        Example:

        repo: registry.example.io/deckhouse/modules
        
      • spec.registry.scheme
        string

        Protocol to access the registry.

        Default: HTTPS

        Allowed values: HTTP, HTTPS

    • spec.releaseChannel
      Deprecated
      string

      Desirable default release channel for modules in the current source.

    • spec.scanInterval
      string

      Interval for registry scan.

      Defines the frequency of checking the container registry for new modules and their versions.

      Defaults to 30 minutes. Explicit intervals shorter than 3 minutes are rounded up to 3 minutes.

      Default: 30m

      Pattern: ^(\d+h)?(\d+m)?(\d+s)?$

      Examples:

      scanInterval: 5m
      
      scanInterval: 1h
      
      scanInterval: 6h30m
      
  • status
    object
    • status.message
      string
    • status.modules
      array of objects

      The list of modules available from the source and their update policies.

      • status.modules.checksum
        string

        The module checksum.

      • status.modules.error
        string

        The module processing error.

      • status.modules.name
        string

        The module name.

      • status.modules.overridden
        boolean

        If ModulePullOverride for this module exists.

      • status.modules.policy
        string

        The module policy name.

      • status.modules.pullError
        string

        The module pull error.

      • status.modules.version
        string

        The module version.

    • status.modulesCount
      integer

      The number of modules available.

    • status.phase
      string

      The current phase.

      Allowed values: Active, Terminating

    • status.syncTime
      string

      When the repository was synchronized.

ModuleUpdatePolicy

Short names: mup

Scope: Cluster

  • v1alpha2
  • v1alpha1

Defines the update settings for a module’s release.

Example:

apiVersion: deckhouse.io/v1alpha2
kind: ModuleUpdatePolicy
metadata:
  name: example-update-policy
spec:
  releaseChannel: Alpha
  update:
    mode: Auto
    windows:
    - days:
      - Mon
      - Wed
      from: '13:30'
      to: '14:00'
  • spec
    object

    Required value

    • spec.releaseChannel
      string

      Desirable module release channel.

      The order in which the stability of the release channel increases (from less stable to more stable): Alpha, Beta, EarlyAccess, Stable, RockSolid.

      Default: Stable

      Allowed values: Alpha, Beta, EarlyAccess, Stable, RockSolid, Lts

    • spec.update
      object

      Required value

      Update settings for target modules.

      • spec.update.mode
        string

        Modules version update mode (release change).

        • AutoPatch — automatic update mode for patch releases.

          To change a minor version (for example, from v1.15.* to v1.16.*), confirmation is required.

          A patch version update (for example, from v1.16.1 to v1.16.2) is applied according to the update windows, if they are set.

        • Auto — all updates are applied automatically.

          Modules minor version updates (for example, from v1.15.* to v1.16.*) and patch version updates (for example, from v1.16.1 to v1.16.2) are applied according to the update windows or (if no update windows are set) as they appear on the corresponding release channel;

        • Manual — confirmation is required for updating both minor and patch versions.

        To confirm the update, add the modules.deckhouse.io/approved="true" annotation to the corresponding ModuleRelease resource.

        Default: Auto

        Allowed values: Auto, Manual, AutoPatch

      • spec.update.windows
        array of objects

        Modules update timetable.

        • spec.update.windows.days
          array of strings

          The days of the week on which the update window is applied.

          Examples:

          days: Mon
          
          days: Wed
          
          • Element of the array
            string

            Day of the week.

            Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

            Example:

            Mon
            
        • spec.update.windows.from
          string

          Required value

          Start time of the update window (UTC timezone).

          Should be less than the end time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          from: '13:00'
          
        • spec.update.windows.to
          string

          Required value

          End time of the update window (UTC timezone).

          Should be more than the start time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          to: '18:30'
          

Deprecated resource. Support for the resource might be removed in a later release.

Defines the update settings for a module’s release.

Example:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleUpdatePolicy
metadata:
  name: example-update-policy
spec:
  moduleReleaseSelector:
    labelSelector:
      matchLabels:
        source: example
        module: module-1
  releaseChannel: Alpha
  update:
    mode: Auto
    windows:
    - days:
      - Mon
      - Wed
      from: '13:30'
      to: '14:00'
  • spec
    object

    Required value

    • spec.moduleReleaseSelector
      object

      Required value

      Selects target modules to apply update settings to.

      • spec.moduleReleaseSelector.labelSelector
        object

        Required value

        Label-selector-based filter to match target modules.

        If both matchExpressions and matchLabels parameters are set, their requirements are ANDed together — they must all be satisfied in order to match. If multiple matchExpression conditions are provided, they all must be satisfied in order to match.

        • spec.moduleReleaseSelector.labelSelector.matchExpressions
          array of objects

          An array of set-based expressions.

          • spec.moduleReleaseSelector.labelSelector.matchExpressions.key
            string

            Required value

            A label name.

          • spec.moduleReleaseSelector.labelSelector.matchExpressions.operator
            string

            Required value

            A comparison operator.

            Allowed values: In, NotIn, Exists, DoesNotExist

          • spec.moduleReleaseSelector.labelSelector.matchExpressions.values
            array of strings

            A label value.

        • spec.moduleReleaseSelector.labelSelector.matchLabels
          object

          A number of equality-based label filters.

          Example:

          matchLabels:
            source: deckhouse
            module: deckhouse-admin
          
    • spec.releaseChannel
      string

      Desirable module release channel.

      The order in which the stability of the release channel increases (from less stable to more stable): Alpha, Beta, EarlyAccess, Stable, RockSolid.

      Default: Stable

      Allowed values: Alpha, Beta, EarlyAccess, Stable, RockSolid

    • spec.update
      object

      Required value

      Update settings for target modules.

      • spec.update.mode
        string

        Modules version update mode (release change).

        • AutoPatch — automatic update mode for patch releases.

          To change a minor version (for example, from v1.15.* to v1.16.*), confirmation is required.

          A patch version update (for example, from v1.16.1 to v1.16.2) is applied according to the update windows, if they are set.

        • Auto — all updates are applied automatically.

          Modules minor version updates (for example, from v1.15.* to v1.16.*) and patch version updates (for example, from v1.16.1 to v1.16.2) are applied according to the update windows or (if no update windows are set) as they appear on the corresponding release channel;

        • Manual — confirmation is required for updating both minor and patch versions.

        To confirm the update, add the modules.deckhouse.io/approved="true" annotation to the corresponding ModuleRelease resource.

        • Ignore — updates are ignored.

        Default: AutoPatch

        Allowed values: Auto, Manual, Ignore, AutoPatch

      • spec.update.windows
        array of objects

        Modules update timetable.

        • spec.update.windows.days
          array of strings

          The days of the week on which the update window is applied.

          Examples:

          days: Mon
          
          days: Wed
          
          • Element of the array
            string

            Day of the week.

            Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

            Example:

            Mon
            
        • spec.update.windows.from
          string

          Required value

          Start time of the update window (UTC timezone).

          Should be less than the end time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          from: '13:00'
          
        • spec.update.windows.to
          string

          Required value

          End time of the update window (UTC timezone).

          Should be more than the start time of the update window.

          Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

          Example:

          to: '18:30'
          

PackageRepository

Scope: Cluster
Version: v1alpha1

PackageRepository defines a package repository available in Deckhouse Platform.

Example:

apiVersion: deckhouse.io/v1alpha1
kind: PackageRepository
metadata:
  name: example
spec:
  registry:
    ca: "<PEM-encoded CA certificate>"
    dockerCfg: "<base64 encoded credentials>"
    login: admin
    password: "<password>"
    repo: registry.example.io/packages
    scheme: https
  scanInterval: 5m
  • spec
    object

    Required value

    Package repository configuration.

    • spec.registry
      object

      Required value

      Access parameters for the container registry where the package repository is located.

      • spec.registry.ca
        string

        Root certificate in PEM format used to verify the TLS certificate of the container registry when connecting over HTTPS.

        Used if the registry uses self-signed SSL certificates.

        Example:

        ca: "<PEM-encoded CA certificate>"
        
      • spec.registry.dockerCfg
        string

        Container registry access configuration in ~/.docker/config.json format, encoded in Base64.

        Leave this field empty for anonymous access.

        Example:

        dockerCfg: "<base64 encoded credentials>"
        
      • spec.registry.login
        string

        Username for authenticating to the container registry.

        Example:

        login: admin
        
      • spec.registry.password
        string

        Password for authenticating to the container registry.

        Example:

        password: "<password>"
        
      • spec.registry.repo
        string

        Required value

        Address of the package repository in the container registry.

        Example:

        repo: registry.example.io/packages
        
      • spec.registry.scheme
        string

        Protocol used to access the package repository, for example, https.

        Example:

        scheme: https
        
    • spec.scanInterval
      string

      Interval between automatic scans of the package repository for discovering new packages and versions.

      Default: 6h

      Pattern: ^(\d+h)?(\d+m)?(\d+s)?$

      Examples:

      scanInterval: 5m
      
      scanInterval: 1h
      
      scanInterval: 6h30m
      
  • status
    object

    Current state of the package repository.

    • status.conditions
      array of objects

      Conditions reflecting the current state of the package repository.

      Condition reflecting an aspect of the current state of the package repository.

      • status.conditions.lastTransitionTime
        string

        Required value

        Time when the condition status last changed.

      • status.conditions.message
        string

        Required value

        Message with additional information about the condition.

        May be empty.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer

        Value of .metadata.generation for which the condition was set.

        Indicates whether the condition corresponds to the current generation of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string

        Required value

        Programmatic identifier indicating the reason for the last condition status change.

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

        Length: 1..1024

      • status.conditions.status
        string

        Required value

        Condition status.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string

        Required value

        Condition type in CamelCase or in the format foo.example.com/CamelCase.

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

        Maximum length: 316

    • status.lastChangeTime
      string

      Time of the last scan that discovered at least one new package version.

      If no new versions are discovered, the value is not updated.

    • status.lastNewVersions
      integer

      Number of new package versions discovered during the last scan.

      Equals 0 if no new versions were discovered.

    • status.lastScanTime
      string

      Time of the last successfully completed scan.

      If a scan fails, the value is not updated, and the error is reflected in the LastScanSucceeded condition.

    • status.message
      string

      Message with additional information about the state of the package repository.

    • status.packages
      array of objects

      List of packages available in the repository.

      • status.packages.name
        string

        Required value

        Package name.

      • status.packages.type
        string

        Required value

        Package type.

    • status.packagesCount
      integer

      Total number of packages in the repository.

    • status.phase
      string

      Current phase of the repository.

PackageRepositoryOperation

Short names: pro

Scope: Cluster
Version: v1alpha1

PackageRepositoryOperation represents an operation for scanning or updating a package repository.

Example:

apiVersion: deckhouse.io/v1alpha1
kind: PackageRepositoryOperation
metadata:
  name: example
spec:
  packageRepositoryName: deckhouse
  type: Update
  update:
    fullScan: false
    timeout: 5m
  • spec
    object

    Required value

    Package repository operation parameters.

    • spec.packageRepositoryName
      string

      Required value

      Name of the package repository for which the operation is performed.

      Example:

      packageRepositoryName: deckhouse
      
    • spec.type
      string

      Required value

      Operation type.

      Allowed values: Update

    • spec.update
      object

      Update operation parameters.

      • spec.update.fullScan
        boolean

        Indicates whether to perform a full scan of the package repository.

      • spec.update.timeout
        string

        Operation timeout.

        Example:

        timeout: 5m
        
  • status
    object

    Current state of the package repository operation.

    • status.completionTime
      string

      Time when the operation completed.

    • status.conditions
      array of objects

      Conditions reflecting the current state of the operation.

      The operation phase is determined by the Completed condition: while its status is False, the operation is in one of the intermediate phases (Discover or Processing). A True status indicates that the operation has completed with the ScanSucceeded or ScanFailed reason.

      Condition reflecting an aspect of the current state of the operation.

      • status.conditions.lastTransitionTime
        string

        Required value

        Time when the condition status last changed.

      • status.conditions.message
        string

        Required value

        Message with additional information about the condition.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer

        Value of .metadata.generation for which the condition was set.

        Indicates whether the condition corresponds to the current generation of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string

        Required value

        Programmatic identifier indicating the reason for the last condition status change.

        For the Completed condition, possible values are Discover, Processing, ScanSucceeded, and ScanFailed.

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

        Length: 1..1024

        Examples:

        reason: Discover
        
        reason: Processing
        
        reason: Succeeded
        
        reason: Failed
        
      • status.conditions.status
        string

        Required value

        Condition status.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string

        Required value

        Condition type in CamelCase or in the format foo.example.com/CamelCase.

        This resource uses the Completed condition, which indicates whether the operation has completed.

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

        Maximum length: 316

    • status.packages
      object

      Information about packages processed during the operation.

      • status.packages.discovered
        array of objects

        Packages discovered during the operation and awaiting processing.

        The list is empty after the operation completes.

        • status.packages.discovered.name
          string

          Required value

          Name of the discovered package.

      • status.packages.failed
        array of objects

        Packages that could not be processed.

        • status.packages.failed.errors
          array of objects

          Required value

          Errors that occurred while processing the package.

          • status.packages.failed.errors.message
            string

            Required value

            Error message.

          • status.packages.failed.errors.version
            string

            Required value

            Package version for which the error occurred.

        • status.packages.failed.name
          string

          Required value

          Name of the package that could not be processed.

      • status.packages.newVersionsOverall
        integer

        Total number of new package versions discovered during the operation.

        A version is considered new if the corresponding ApplicationPackageVersion or ModulePackageVersion did not exist in the cluster.

        An ApplicationPackageVersion is also considered new if it was previously marked as missing from the container registry, but its image was discovered during the current operation.

      • status.packages.processed
        array of objects

        Successfully processed packages.

        • status.packages.processed.foundVersions
          integer

          Number of package versions discovered during the operation.

        • status.packages.processed.name
          string

          Required value

          Name of the processed package.

        • status.packages.processed.newVersions
          integer

          Number of new package versions discovered during the operation.

          A version is considered new if the corresponding ApplicationPackageVersion or ModulePackageVersion did not exist in the cluster.

          An ApplicationPackageVersion is also considered new if it was previously marked as missing from the container registry, but its image was discovered during the current operation.

        • status.packages.processed.type
          string

          Package type.

      • status.packages.processedOverall
        integer

        Total number of processed packages.

      • status.packages.total
        integer

        Total number of discovered packages.

    • status.startTime
      string

      Time when the operation started.

SSHConfig

Version: dhctl.deckhouse.io/v1

General dhctl SSH config.

Example:

apiVersion: dhctl.deckhouse.io/v1
kind: SSHConfig
sshUser: user
sshPort: 22
sshExtraArgs: "-vvv"
sshAgentPrivateKeys:
- key: "<ssh-private-key>"
  • apiVersion
    string

    Version of the Deckhouse API.

    Allowed values: dhctl.deckhouse.io/v1

  • kind
    string

    Allowed values: SSHConfig

  • legacyMode
    boolean

    Switch to legacy SSH mode (clissh).

  • modernMode
    boolean

    Switch to modern SSH mode (gossh).

  • sshAgentPrivateKeys
    array of objects
    • sshAgentPrivateKeys.key
      string

      Required value

      Contents of the private SSH key.

      This field does not support passing a certificate. To authenticate with a certificate in gossh mode, load the key together with its certificate into an ssh-agent accessible to dhctl through SSH_AUTH_SOCK. This method is unavailable when legacyMode: true.

    • sshAgentPrivateKeys.passphrase
      string

      Password for SSH key.

  • sshBastionHost
    string

    SSH bastion host.

  • sshBastionPassword
    string

    A password for the bastion user.

  • sshBastionPort
    integer

    Port of SSH bastion.

  • sshBastionUser
    string

    Username for bastion.

  • sshExtraArgs
    string

    Additional arguments for SSH connection.

  • sshPort
    integer

    SSH port.

  • sshUser
    string

    SSH username.

  • sudoPassword
    string

    A sudo password for the user.

SSHHost

Version: dhctl.deckhouse.io/v1

General dhctl SSH host config.

Example:

apiVersion: dhctl.deckhouse.io/v1
kind: SSHHost
host: 172.16.0.0
  • apiVersion
    string

    Required value

    Version of the Deckhouse API.

    Allowed values: dhctl.deckhouse.io/v1

  • host
    string

    Required value

    Host.

  • kind
    string

    Required value

    Allowed values: SSHHost

StaticClusterConfiguration

Version: deckhouse.io/v1

Parameters of a static (bare metal) cluster.

To change the StaticClusterConfiguration resource in a running cluster, run the following command:

d8 system edit static-cluster-configuration

Example:

apiVersion: deckhouse.io/v1
kind: StaticClusterConfiguration
internalNetworkCIDRs:
- 10.244.0.0/16
- 10.50.0.0/16
  • apiVersion
    string

    Required value

    Version of the Deckhouse API.

    Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

  • internalNetworkCIDRs
    array of strings

    List of internal cluster networks.

    Internal cluster networks connect Kubernetes components (kube-apiserver, kubelet, etc.).

    The parameter is mandatory in the following cases:

    • Cluster nodes have more than one network interface
    • The cluster is deployed inside a Deckhouse Virtualization Platform

    When changing the value, subnets in the new list must include IP addresses of currently joined nodes.

    Example:

    internalNetworkCIDRs:
    - 192.168.42.0/24
    - 172.16.16.0/24
    
    • Element of the array
      string

      Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

  • kind
    string

    Required value

    Allowed values: StaticClusterConfiguration