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
- objectspec
Required value
Application configuration.
- stringspec.maintenance
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
ApplicationIsInMaintenanceModealert is triggered.
Allowed values:
NoResourceReconciliationExample:
maintenance: NoResourceReconciliation -
- stringspec.packageName
Required value
Name of the application package to install.
Example:
packageName: console - stringspec.packageRepositoryName
Name of the PackageRepository object where the application package is located.
Example:
packageRepositoryName: deckhouse - stringspec.packageVersion
Required value
Version of the application package to install.
Example:
packageVersion: v1.0.0 - array of objectsspec.resourceRequests
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.
- array of objectsspec.resourceRequests.containers
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.
- stringspec.resourceRequests.containers.name
Required value
Name of the container inside the workload.
Example:
name: controller - objectspec.resourceRequests.containers.resources
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
resourcesfield of a Pod container. Supportscpu,memory, andephemeral-storage.Specified values are merged with the settings from the application package separately for each resource. For example, if only
memoryis specified, thecpuvalue 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
cpuormemory, a request set for that resource remains fixed. If acpuormemorylimit is set, VPA does not change the container’s limits. TheApplicationVerticalPodAutoscalerPinnedalert is triggered if a request or limit is set for a resource controlled by VPA.To let VPA choose requests within a range, set
minandmaxinstead ofcpuandmemoryrequests and limits.- array of objectsspec.resourceRequests.containers.resources.claims
List of resource claims used by the container.
Each entry references a resource claim defined in
pod.spec.resourceClaims. Requires theDynamicResourceAllocationfeature gate to be enabled.This field is immutable. It can only be set for containers.
Resource claim used by the container.
- stringspec.resourceRequests.containers.resources.claims.name
Required value
Name of a ResourceClaim defined in
pod.spec.resourceClaims.The referenced claim makes its resources available to the container.
- stringspec.resourceRequests.containers.resources.claims.request
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.
- objectspec.resourceRequests.containers.resources.limits
Maximum amount of compute resources available to the container.
- objectspec.resourceRequests.containers.resources.max
Upper bound of the container’s
cpuandmemoryrequests that VerticalPodAutoscaler sets (maxAllowedin its policy for the container).Set together with
minfor the same resources. Within the range, the requests are chosen by VPA, so a container withminandmaxcannot havecpuormemoryrequests or limits. A resource bound cannot be less than inmin.If no VerticalPodAutoscaler of the application sets a resource of the container, for example, because the
vertical-pod-autoscalermodule is disabled, the container getsminas the request andmaxas the limit of the resource, and theApplicationVerticalPodAutoscalerMissingalert is triggered.- integer or stringspec.resourceRequests.containers.resources.max.cpu
Bound of the
cpurequest.Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$Example:
cpu: 250m - integer or stringspec.resourceRequests.containers.resources.max.memory
Bound of the
memoryrequest.Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$Example:
memory: 256Mi
- objectspec.resourceRequests.containers.resources.min
Lower bound of the container’s
cpuandmemoryrequests that VerticalPodAutoscaler sets (minAllowedin its policy for the container).Set together with
maxfor the same resources. Within the range, the requests are chosen by VPA, so a container withminandmaxcannot havecpuormemoryrequests or limits. To fix a resource at one value, specify the same value inminandmax.If no VerticalPodAutoscaler of the application sets a resource of the container, for example, because the
vertical-pod-autoscalermodule is disabled, the container getsminas the request andmaxas the limit of the resource, and theApplicationVerticalPodAutoscalerMissingalert is triggered.- integer or stringspec.resourceRequests.containers.resources.min.cpu
Bound of the
cpurequest.Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$Example:
cpu: 250m - integer or stringspec.resourceRequests.containers.resources.min.memory
Bound of the
memoryrequest.Pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$Example:
memory: 256Mi
- objectspec.resourceRequests.containers.resources.requests
Minimum amount of compute resources required by the container.
If this parameter is not specified, the
limitsvalue is used if explicitly set. Otherwise, the value is implementation-defined.The
requestsvalue cannot exceedlimits.
- stringspec.resourceRequests.kind
Required value
Kind of workload for which resource settings are specified.
Allowed values:
Deployment,StatefulSet,DaemonSet,ReplicaSet,Pod,Job,CronJobExample:
kind: Deployment - integerspec.resourceRequests.maxReplicas
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 withreplicas: 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
minReplicasreplicas, and theApplicationHorizontalPodAutoscalerMissingalert is triggered.Allowed values:
1 <= XExample:
maxReplicas: 10 - integerspec.resourceRequests.minReplicas
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 withreplicas: within the range, the number of replicas is chosen by the HorizontalPodAutoscaler. Cannot be greater thanmaxReplicas.If the application does not deploy a HorizontalPodAutoscaler for the workload, the workload runs
minReplicasreplicas, and theApplicationHorizontalPodAutoscalerMissingalert is triggered.Allowed values:
1 <= XExample:
minReplicas: 2 - stringspec.resourceRequests.name
Required value
Workload name as specified in the application package.
Example:
name: controller - integerspec.resourceRequests.replicas
Number of workload replicas.
Applies only to workloads that support replica management: Deployment, StatefulSet, and ReplicaSet. Cannot be set together with
minReplicasormaxReplicas.If the application deploys a HorizontalPodAutoscaler for the workload, its
minReplicasandmaxReplicasare set to this value, so the number of replicas does not change, and theApplicationHorizontalPodAutoscalerPinnedalert is triggered. To let HorizontalPodAutoscaler scale the workload, setminReplicasandmaxReplicasinstead. The value0applies only to the workload: HorizontalPodAutoscaler does not scale a workload with no replicas.Allowed values:
0 <= XExample:
replicas: 3 - array of objectsspec.resourceRequests.volumeClaimTemplates
Disk sizes for the StatefulSet’s volume claim templates.
Applies only to StatefulSet. Each template is identified by its name, the
metadata.nameof an entry inspec.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.
- stringspec.resourceRequests.volumeClaimTemplates.name
Required value
Name of the volume claim template in the StatefulSet.
Example:
name: data - integer or stringspec.resourceRequests.volumeClaimTemplates.storage
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
- objectspec.settings
Configuration application settings.
- numberspec.settingsVersion
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.
- objectspec.update
Application update settings: update mode and update windows.
If this parameter is not specified, the
Manualupdate mode is used.Update notifications cannot be configured for an application: the
update.notificationsettings of thedeckhousemodule are used.Example:
update: mode: Auto windows: - from: '8:00' to: '15:00' days: - Tue - Sat- stringspec.update.mode
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.*tov1.3.*), confirmation is required.A patch version update (for example, from
v1.3.1tov1.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.*tov1.3.*) and patch version updates (for example, fromv1.3.1tov1.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,ManualExamples:
mode: AutoPatchmode: Automode: Manual -
- array of objectsspec.update.windows
List of application update windows.
Time interval during the day when application updates are allowed.
- array of stringsspec.update.windows.days
Days of the week on which the update window is applied.
If the parameter is omitted, the update window is applied every day.
- stringElement of the array
Allowed values:
Mon,Tue,Wed,Thu,Fri,Sat,Sun
- stringspec.update.windows.from
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' - stringspec.update.windows.to
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'
- objectstatus
Current state of the application.
- array of objectsstatus.conditions
Conditions reflecting the current state of the application.
Condition reflecting an aspect of the current state of the application.
- stringstatus.conditions.lastTransitionTime
Required value
Time when the condition status last changed.
- stringstatus.conditions.message
Required value
Message with additional information about the condition.
Maximum length:
32768 - integerstatus.conditions.observedGeneration
Value of
.metadata.generationfor which the condition was set.Indicates whether the condition corresponds to the current generation of the instance.
Allowed values:
0 <= X - stringstatus.conditions.reason
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 - stringstatus.conditions.status
Required value
Condition status.
Allowed values:
True,False,Unknown - stringstatus.conditions.type
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
- objectstatus.currentVersion
Information about the currently installed application version.
- stringstatus.currentVersion.version
Installed application version in SemVer format.
- objectstatus.lastAppliedConfiguration
Application configuration used during the last successful apply.
Includes user-defined settings and default values defined in the configuration schema.
- objectstatus.summary
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.
- stringstatus.summary.message
Description of the current application state.
- stringstatus.summary.state
Current application lifecycle state.
Examples:
state: Pendingstate: Failedstate: Updatingstate: Configuringstate: Readystate: Degradedstate: Suspendedstate: Deleting - stringstatus.summary.tip
Recommended action for the current application state.
May be empty if no additional action is required.
- objectstatus.tracking
Nelm report on application status.
- objectstatus.update
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.
- stringstatus.update.automaticVersion
Version the automatic update installs next. It changes only after the previous one is installed and ready. Empty in the
Manualupdate mode. - objectstatus.update.notified
Notification sent about the pending update: the version it announced and when it was sent.
It is sent to the webhook of the
update.notificationsettings of thedeckhousemodule. The update is installed no earlier thanminimalNotificationTimeafter the notification. Cleared once a new version is installed or the update is cancelled.- stringstatus.update.notified.time
Required value
Time the notification was sent.
- stringstatus.update.notified.version
Required value
Version the notification announced.
- array of stringsstatus.update.plan
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.
- array of objectsstatus.urls
Application endpoint URLs obtained from Ingress, HTTPRoute, and ServiceAccount resources in the application chart with the
packages.deckhouse.io/application-endpoint-descriptionannotation. 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.
- stringstatus.urls.description
Endpoint description from the
packages.deckhouse.io/application-endpoint-descriptionannotation.The description is empty if the annotation value is
"true". - stringstatus.urls.url
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
- objectstatus
Current state of the application package.
- array of stringsstatus.availableRepositories
List of repository names where the application package is available.
- objectstatus.releaseChannels
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.
- array of objectsstatus.usedBy
List of applications installed from this package.
Application installed from the package.
- stringstatus.usedBy.name
Name of the application instance.
- stringstatus.usedBy.namespace
Namespace where the application is installed.
- stringstatus.usedBy.repositoryName
Name of the PackageRepository from which the application was installed.
- stringstatus.usedBy.version
Package version used by the application.
- integerstatus.usedByCount
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
- objectspec
Application package version parameters.
- stringspec.packageName
Required value
Name of the application package.
Example:
packageName: console - stringspec.packageRepositoryName
Required value
Name of the package repository containing the package.
Example:
packageRepositoryName: deckhouse - stringspec.packageVersion
Required value
Version of the application package.
Example:
packageVersion: v1.0.0
- objectstatus
Current state of the application package version.
- array of objectsstatus.conditions
Conditions reflecting the current state of the application package version.
Condition reflecting an aspect of the current state of the package version.
- stringstatus.conditions.lastTransitionTime
Required value
Time when the condition status last changed.
- stringstatus.conditions.message
Required value
Message with additional information about the condition.
May be empty.
Maximum length:
32768 - integerstatus.conditions.observedGeneration
Value of
.metadata.generationfor which the condition was set.Indicates whether the condition corresponds to the current generation of the instance.
Allowed values:
0 <= X - stringstatus.conditions.reason
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 - stringstatus.conditions.status
Required value
Condition status.
Allowed values:
True,False,Unknown - stringstatus.conditions.type
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
- integerstatus.observedGeneration
Value of
.metadata.generationfor 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 - objectstatus.packageMetadata
Application package version metadata, including the description, requirements, disable options, and version compatibility rules.
- stringstatus.packageMetadata.category
Application package category.
- objectstatus.packageMetadata.changelog
Information about changes in this package version.
- array of stringsstatus.packageMetadata.changelog.features
List of new features in this package version.
- array of stringsstatus.packageMetadata.changelog.fixes
List of bugs fixed in this package version.
- objectstatus.packageMetadata.description
Localized descriptions of the application package.
- stringstatus.packageMetadata.description.en
English description of the application package.
- stringstatus.packageMetadata.description.ru
Russian description of the application package.
- objectstatus.packageMetadata.disableOptions
Parameters of package disable protection.
- booleanstatus.packageMetadata.disableOptions.confirmation
Indicates whether confirmation is required to disable the application package.
- objectstatus.packageMetadata.disableOptions.messages
Localized messages displayed when confirming package disabling.
- stringstatus.packageMetadata.disableOptions.messages.en
Disable confirmation message in English.
- stringstatus.packageMetadata.disableOptions.messages.ru
Disable confirmation message in Russian.
- objectstatus.packageMetadata.licensing
Application package licensing information for different editions.
- objectstatus.packageMetadata.licensing.editions
Licensing settings for different application package editions.
- objectstatus.packageMetadata.licensing.editions.<KEY_NAME>
<KEY_NAME>— item (key) name.- booleanstatus.packageMetadata.licensing.editions.<KEY_NAME>.available
Indicates whether the edition is available for use.
- array of stringsstatus.packageMetadata.licensing.editions.<KEY_NAME>.enabledInBundles
Bundles in which the package is enabled by default in this edition.
Not used for application packages.
- objectstatus.packageMetadata.requirements
System requirements for installing and running the application.
- objectstatus.packageMetadata.requirements.deckhouse
Required Deckhouse Platform version.
- stringstatus.packageMetadata.requirements.deckhouse.constraint
Deckhouse Platform version constraint in SemVer format.
- objectstatus.packageMetadata.requirements.kubernetes
Required Kubernetes version.
- stringstatus.packageMetadata.requirements.kubernetes.constraint
Kubernetes version constraint in SemVer format.
- objectstatus.packageMetadata.requirements.modules
Deckhouse Platform module requirements: required and optional dependencies, groups of alternative modules, and groups of incompatible modules.
- array of objectsstatus.packageMetadata.requirements.modules.anyOf
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.
- stringstatus.packageMetadata.requirements.modules.anyOf.description
Human-readable description of the group’s purpose.
- array of objectsstatus.packageMetadata.requirements.modules.anyOf.modules
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.
- stringstatus.packageMetadata.requirements.modules.anyOf.modules.constraint
Module version constraint in SemVer format.
- stringstatus.packageMetadata.requirements.modules.anyOf.modules.name
Required value
Module name.
- stringstatus.packageMetadata.requirements.modules.anyOf.name
Required value
Stable identifier used by the scheduler in diagnostics.
- array of objectsstatus.packageMetadata.requirements.modules.conditional
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
!optionalsuffix from the v1 requirements format.Optional module with a version constraint in SemVer format.
If no constraint is specified, any version is allowed.
- stringstatus.packageMetadata.requirements.modules.conditional.constraint
Module version constraint in SemVer format.
- stringstatus.packageMetadata.requirements.modules.conditional.name
Required value
Module name.
- array of objectsstatus.packageMetadata.requirements.modules.mandatory
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.
- stringstatus.packageMetadata.requirements.modules.mandatory.constraint
Module version constraint in SemVer format.
- stringstatus.packageMetadata.requirements.modules.mandatory.name
Required value
Module name.
- array of objectsstatus.packageMetadata.requirements.modules.noneOf
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.
- stringstatus.packageMetadata.requirements.modules.noneOf.description
Human-readable description of the group’s purpose.
- array of objectsstatus.packageMetadata.requirements.modules.noneOf.modules
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.
- stringstatus.packageMetadata.requirements.modules.noneOf.modules.constraint
Module version constraint in SemVer format defining the range of incompatible versions.
- stringstatus.packageMetadata.requirements.modules.noneOf.modules.name
Required value
Module name.
- stringstatus.packageMetadata.requirements.modules.noneOf.name
Required value
Stable identifier used by the scheduler in diagnostics.
- stringstatus.packageMetadata.stage
Life cycle stage of the application package.
Examples:
stage: Experimentalstage: Previewstage: General Availabilitystage: Deprecated - objectstatus.packageMetadata.versionCompatibilityRules
Version compatibility rules for upgrades and downgrades.
- objectstatus.packageMetadata.versionCompatibilityRules.downgrade
Compatibility rules for downgrading from this application version.
Default:
{"step":{"major":0,"minor":0,"patches":-1}}- objectstatus.packageMetadata.versionCompatibilityRules.downgrade.step
Compatibility rule step.
- integerstatus.packageMetadata.versionCompatibilityRules.downgrade.step.major
Number of major versions that can be skipped during a downgrade.
The
-1value removes all limits,0forbids the change.Defaults to
0.Allowed values:
-1 <= X - integerstatus.packageMetadata.versionCompatibilityRules.downgrade.step.minor
Number of minor versions that can be skipped during a downgrade.
The
-1value removes all limits,0forbids the change.Defaults to
0.Allowed values:
-1 <= X - integerstatus.packageMetadata.versionCompatibilityRules.downgrade.step.patches
Number of patch versions that can be skipped during a downgrade.
The
-1value removes all limits,0forbids the change.Defaults to
-1.Allowed values:
-1 <= X
- objectstatus.packageMetadata.versionCompatibilityRules.upgrade
Compatibility rules for upgrading to and from this application version.
Default:
{"step":{"major":0,"minor":1,"patches":-1}}- stringstatus.packageMetadata.versionCompatibilityRules.upgrade.from
SemVer constraint on the application versions from which the application can be upgraded to this version.
If specified, the constraint takes priority over the
steplimits 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 ofspec.packageVersionof the Application. An invalid constraint forbids upgrading to this version.If not specified, the
steplimits of the version being upgraded from apply. - objectstatus.packageMetadata.versionCompatibilityRules.upgrade.step
Compatibility rule step.
- integerstatus.packageMetadata.versionCompatibilityRules.upgrade.step.major
Number of major versions that can be skipped during an upgrade.
The
-1value removes all limits,0forbids the change.Defaults to
0.Allowed values:
-1 <= X - integerstatus.packageMetadata.versionCompatibilityRules.upgrade.step.minor
Number of minor versions that can be skipped during an upgrade.
The
-1value removes all limits,0forbids the change.Defaults to
1.Allowed values:
-1 <= X - integerstatus.packageMetadata.versionCompatibilityRules.upgrade.step.patches
Number of patch versions that can be skipped during an upgrade.
The
-1value removes all limits,0forbids the change.Defaults to
-1.Allowed values:
-1 <= X
- objectstatus.packageSchemas
OpenAPI schemas for validating user-defined application settings and final values passed to package hooks and templates.
- array of objectsstatus.packageSchemas.settingsConversions
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.
- objectstatus.packageSchemas.settingsConversions.descriptions
Localized description of the changes in this settings schema version.
- stringstatus.packageSchemas.settingsConversions.descriptions.en
English description of the conversion.
- stringstatus.packageSchemas.settingsConversions.descriptions.ru
Russian description of the conversion.
- array of stringsstatus.packageSchemas.settingsConversions.expr
Required value
jq expressions applied to the settings in order.
- integerstatus.packageSchemas.settingsConversions.version
Required value
Settings schema version the conversion produces; it converts settings of the previous version.
- objectstatus.packageSchemas.settingsSchema
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.
- objectstatus.packageSchemas.valuesSchema
OpenAPI v3 schema for validating the final set of
valuespassed 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.
- array of objectsstatus.usedBy
List of applications installed from this package version.
Application installed from the package version.
- stringstatus.usedBy.name
Name of the application instance.
- stringstatus.usedBy.namespace
Namespace where the application is installed.
- integerstatus.usedByCount
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
- stringapiVersion
Required value
Version of the Deckhouse API.
Allowed values:
deckhouse.io/v1,deckhouse.io/v1alpha1 - stringcloud.prefixDeprecated
A prefix of the objects to be created in the cloud.
Deprecated. Use
prefixin theglobalModuleConfig 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 - stringcloud.provider
Required value
Cloud provider.
Allowed values:
OpenStack,AWS,GCP,Yandex,vSphere,Azure,VCD,Zvirt,Dynamix,Huaweicloud,DVP
- stringclusterDomainDeprecated
Deprecated. Use
clusterDomainin thenetworksection of thecontrol-plane-managerModuleConfig 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.localandpublicDomainTemplate: %s.cluster.localat 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
D8ObsoleteClusterDomainInClusterConfigurationalert. Remove it here only after the ModuleConfig carries the domain. - stringclusterType
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 - stringdefaultCRI
The container runtime type that used on cluster nodes (NodeGroups) by default.
If the value
NotManagedis 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
ContainerdV2is set,CgroupsV2will be used (providing improved security and resource management). To useContainerdV2as 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
244or newer. - Support for
erofskernel module.
Default:
ContainerdAllowed values:
Containerd,ContainerdV2,NotManaged - Support for
- stringencryptionAlgorithmDeprecated
Deprecated. Use
encryptionAlgorithmin thecontrol-plane-managerModuleConfig 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:
apiserverapiserver-kubelet-clientapiserver-etcd-clientfront-proxy-clientetcd-serveretcd-peeretcd-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 - stringkind
Required value
Allowed values:
ClusterConfiguration - stringkubernetesVersionDeprecated
Deprecated. Use
kubernetesVersionin thecontrol-plane-managerModuleConfig instead (d8 k edit mc control-plane-manager).The cluster Kubernetes version is resolved in the following order:
kubernetesVersionparameter in thecontrol-plane-managerModuleConfig, then this field, then the version the current DP release defaults to. The ModuleConfig setting wins whenever it is set,Defaultincluded.This field is optional. While it pins a version and the
kubernetesVersionin thecontrol-plane-managerModuleConfig setting is unset, this field is what decides the cluster version. TheD8ObsoleteKubernetesVersionFieldInClusterConfigurationalert 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
kubernetesVersionin thecontrol-plane-managerModuleConfig instead.If
Automaticis 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 - stringpodSubnetCIDRDeprecated
Deprecated. Use
podSubnetCIDRin thenetworksection of thecontrol-plane-managerModuleConfig 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-doingcommand. 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]))$ - stringpodSubnetNodeCIDRPrefixDeprecated
Deprecated. Use
podSubnetNodeCIDRPrefixin thenetworksection of thecontrol-plane-managerModuleConfig 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/16andpodSubnetNodeCIDRPrefix: "24", each node will receive a/24subnet (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
/16network and/24prefix: maximum 256 nodes (2^(24-16) = 256) - With
/16network and/25prefix: 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-doingcommand. 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,
24is used. - With
- objectproxy
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, andNO_PROXYfor all cluster nodes and Deckhouse components. This will result in HTTP(S) requests (curl, git, registry, etc.) to all resources not listed in thenoProxyparameter being made through a proxy. Note that thepodSubnetCIDRandserviceSubnetCIDRsubnets, as well as theclusterDomaindomain are added tonoProxyautomatically.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
noProxyparameter.- stringproxy.httpProxy
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.myhttpProxy: https://user:password@proxy.company.my:8443httpProxy: https://DOMAIN%5Cuser:password@proxy.company.my:8443httpProxy: https://user%40domain.local:password@proxy.company.my:8443 - stringproxy.httpsProxy
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.myhttpsProxy: https://user:password@proxy.company.my:8443httpsProxy: https://DOMAIN%5Cuser:password@proxy.company.my:8443httpsProxy: https://user%40domain.local:password@proxy.company.my:8443 - array of stringsproxy.noProxy
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.
- stringElement of the array
Pattern:
^[a-z0-9\-\./]+$
- stringserviceSubnetCIDRDeprecated
Deprecated. Use
serviceSubnetCIDRin thenetworksection of thecontrol-plane-managerModuleConfig 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-doingcommand. 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.
- objectspec
Defines the desired state of CNI migration.
- stringspec.targetCNI
The target CNI to migrate to.
- objectstatus
Defines the observed state of CNI migration.
- array of objectsstatus.conditions
Reflect the state of the migration as a whole.
- stringstatus.conditions.lastTransitionTime
Required value
- stringstatus.conditions.message
Required value
- stringstatus.conditions.reason
Required value
- stringstatus.conditions.status
Required value
- stringstatus.conditions.type
Required value
- stringstatus.currentCNI
The detected CNI from which the switch is being made.
- array of objectsstatus.failedSummary
Details about nodes that failed the migration.
- stringstatus.failedSummary.node
- stringstatus.failedSummary.reason
- integerstatus.nodesFailed
The number of nodes where an error occurred.
- integerstatus.nodesSucceeded
The number of nodes that have successfully completed the current phase.
- integerstatus.nodesTotal
The total number of nodes involved in the migration.
- stringstatus.phase
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.
- objectspec
Defines the desired state of CNI migration on a node.
- objectstatus
Defines the observed state of CNI migration on a node.
- array of objectsstatus.conditions
A list of conditions for this migration.
- stringstatus.conditions.lastTransitionTime
Required value
- stringstatus.conditions.message
Required value
- stringstatus.conditions.reason
Required value
- stringstatus.conditions.status
Required value
- stringstatus.conditions.type
Required value
- stringstatus.phase
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.
- booleanapproved
Allows or disables manual updates.
Used only if the
deckhousemodule is configured for manual update mode (update.mode parameter is set toManual). Ignored if the update mode is set toAutoorAutoPatch.For more information on confirming manual updates, refer to the documentation.
Default:
false - objectspec
Required value
- stringspec.applyAfter
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.messagefor the reason. - objectspec.changelog
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.
- stringspec.changelogLink
Link to site with full changelog for this release.
- array of stringsspec.disruptionsDeprecated
Disruptive changes in the release.
- objectspec.requirements
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.messageof the DeckhouseRelease object. - stringspec.version
Required value
DP version.
Example:
version: v1.73.2
- objectstatus
- booleanstatus.approved
The status of the release’s readiness for deployment. It makes sense only for Manual updates (
update.mode: Manual). - stringstatus.message
Detailed status or error message.
- stringstatus.phase
Current status of the release.
Allowed values:
Pending,Deployed,Outdated,Suspended,Superseded,Skipped - stringstatus.transitionTime
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-----
- stringapiVersion
Required value
Version of the Deckhouse API.
Allowed values:
deckhouse.io/v1,deckhouse.io/v1alpha1 - objectdeckhouseDeprecated
Required value
Initial parameters required to install Deckhouse.
- stringdeckhouse.devBranchDeprecated
The parameter is used for development needs. Will be replaced with the CLI-tools.
- stringdeckhouse.imagesRepo
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/cePattern:
^[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?(\/[0-9a-zA-Z\.\-\_\/]+)?$ - stringdeckhouse.registryCA
Root CA certificate to validate the container registry’s HTTPS certificate (if self-signed certificates are used).
- stringdeckhouse.registryDockerCfg
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.myunder the userusernamewith the passwordpasswordit will beeyJhdXRocyI6eyJyZWdpc3RyeS5jb21wYW55Lm15Ijp7ImF1dGgiOiJkWE5sY201aGJXVTZjR0Z6YzNkdmNtUT0ifX19Cg==(string{"auths":{"registry.company.my":{"auth":"dXNlcm5hbWU6cGFzc3dvcmQ="}}}in Base64).Default:
Example:
registryDockerCfg: eyJhdXRocyI6IHsgInJlZ2lzdHJ5LmRlY2tob3VzZS5pbyI6IHt9fX0= - stringdeckhouse.registryScheme
Registry access scheme (HTTP or HTTPS).
Default:
HTTPSAllowed values:
HTTP,HTTPS
- stringkind
Required value
Allowed values:
InitConfiguration
Module
Scope: Cluster
- v1beta1
- v1alpha1
Module represents a module instance managed via the package system.
- objectspec
Required value
Spec defines the behavior of a Module.
- booleanspec.enabled
Enables or disables the module. Unset leaves the decision to the platform.
- stringspec.maintenance
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
ModuleIsInMaintenanceModealert is triggered.
Allowed values:
NoResourceReconciliation -
- stringspec.packageRepositoryName
Name of the repository where the package is located. If not specified, the default repository is used.
Example:
packageRepositoryName: deckhouse - stringspec.packageVersion
Required value
Version of the module package to install.
Example:
packageVersion: v1.0.0 - stringspec.releaseChannel
Release channel for the module package.
- objectspec.settings
Configuration settings for the module.
- numberspec.settingsVersion
Version of the settings schema. Distinct from packageVersion, which selects the module package.
- objectspec.update
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- objectspec.update.blockOnAlerts
Settings for blocking module updates while there are alerts in the cluster.
- booleanspec.update.blockOnAlerts.enabled
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
severityparameter. - integerspec.update.blockOnAlerts.severity
Alert severity level at which updates are blocked.
Set as a value from
0to9, where0is the highest severity and9is the lowest.Default:
4Allowed values:
0 <= X <= 9
- stringspec.update.mode
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.*tov1.3.*), confirmation is required.A patch version update (for example, from
v1.3.1tov1.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.*tov1.3.*) and patch version updates (for example, fromv1.3.1tov1.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:
AutoPatchAllowed values:
AutoPatch,Auto,ManualExamples:
mode: AutoPatchmode: Automode: Manual -
- array of objectsspec.update.windows
List of module update windows.
Time interval during the day when module updates are allowed.
- array of stringsspec.update.windows.days
Days of the week on which the update window is applied.
If the parameter is omitted, the update window is applied every day.
- stringElement of the array
Allowed values:
Mon,Tue,Wed,Thu,Fri,Sat,Sun
- stringspec.update.windows.from
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' - stringspec.update.windows.to
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'
- objectstatus
Status of a Module.
- array of objectsstatus.conditions
Conditions reflecting the latest observations of the module state.
Condition contains details for one aspect of the current state of this API Resource.
- stringstatus.conditions.lastTransitionTime
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.
- stringstatus.conditions.message
Required value
message is a human readable message indicating details about the transition. This may be an empty string.
Maximum length:
32768 - integerstatus.conditions.observedGeneration
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 - stringstatus.conditions.reason
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 - stringstatus.conditions.status
Required value
status of the condition, one of True, False, Unknown.
Allowed values:
True,False,Unknown - stringstatus.conditions.type
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
- objectstatus.currentVersion
Information about the currently installed version.
- stringstatus.currentVersion.channel
Release channel from which the version was installed.
- stringstatus.currentVersion.version
Semantic version of the installed module.
- booleanstatus.enabled
Reports whether the module is enabled:
spec.enabledresolved against the edition bundle, the enabled-script and the module dependencies. It can differ fromspec.enabled— an explicitly enabled module stays disabled while a module it requires is disabled. Absent until the first decision. - objectstatus.lastAppliedConfiguration
LastAppliedConfiguration is the effective settings (user configuration merged with config-schema defaults) that drove the most recent successful apply.
- objectstatus.summary
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.
- stringstatus.summary.message
Message is a human-readable description of the current state.
- stringstatus.summary.state
State is the high-level lifecycle state observed for the module. Always one of: Pending, Failed, Updating, Configuring, Ready, Degraded, Suspended, Deleting.
Examples:
state: Pendingstate: Failedstate: Updatingstate: Configuringstate: Readystate: Degradedstate: Suspendedstate: Deleting - stringstatus.summary.tip
Tip is a human-readable instruction on how to resolve the current state. Empty when no action is required.
- objectstatus.tracking
Nelm tracking.
Describes the module’s status in the cluster. The Module object is created automatically after configuring the ModuleSource and successfully completing synchronization.
- objectproperties
- objectproperties.accessibility
Module accessibility settings.
- objectproperties.accessibility.editions
Module operation settings in Deckhouse editions.
- objectproperties.accessibility.editions.<KEY_NAME>
<KEY_NAME>— item (key) name.- booleanproperties.accessibility.editions.<KEY_NAME>.available
- array of stringsproperties.accessibility.editions.<KEY_NAME>.enabledInBundles
- array of stringsproperties.availableSources
Available sources for downloading the module.
- booleanproperties.critical
Indicates whether the module critical or not.
- objectproperties.disableOptions
Parameters of module disable protection.
- booleanproperties.disableOptions.confirmation
- stringproperties.disableOptions.message
Deprecated: use Messages with localized ru/en fields instead.
- objectproperties.disableOptions.messages
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
messagefield is used instead.- stringproperties.disableOptions.messages.en
- stringproperties.disableOptions.messages.ru
- stringproperties.exclusiveGroup
Indicates the group where only one module can be active at a time.
- stringproperties.namespace
Module namespace.
- stringproperties.releaseChannel
Module release channel.
- objectproperties.requirements
Module dependencies, a set of requirements that must be met for Deckhouse Kubernetes Platform (DKP) to run the module.
- stringproperties.requirements.bootstrapped
Required cluster installation status (for built-in DKP modules only).
- stringproperties.requirements.deckhouse
Required Deckhouse version.
- stringproperties.requirements.kubernetes
Required Kubernetes version.
- objectproperties.requirements.modules
A list of other enabled modules required for the module.
- stringproperties.source
Source the module was downloaded from (otherwise will be blank).
- stringproperties.stage
Current stage of the module lifecycle.
- array of stringsproperties.subsystems
Module subsystems.
- stringproperties.updatePolicy
Module update policy.
- stringproperties.version
Module version.
- integerproperties.weight
Module weight (priority).
- objectspec
- objectstatus
- array of objectsstatus.conditions
- stringstatus.conditions.lastProbeTime
- stringstatus.conditions.lastTransitionTime
- stringstatus.conditions.message
- stringstatus.conditions.reason
- stringstatus.conditions.status
- stringstatus.conditions.type
- stringstatus.hooksState
Hooks status report.
- stringstatus.phase
Module phase.
Allowed values:
Unavailable,Available,Downloading,DownloadingError,Reconciling,Installing,HooksDisabled,WaitSyncTasks,Downloaded,Conflict,Ready,ErrorExamples:
phase: Unavailablephase: Availablephase: Downloadingphase: DownloadingErrorphase: Reconcilingphase: Installingphase: HooksDisabledphase: WaitSyncTasksphase: Downloadedphase: Conflictphase: Readyphase: 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
- objectspec
Required value
- booleanspec.enabled
Enables or disables the module.
Example:
enabled: false - stringspec.maintenance
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
ModuleIsInMaintenanceModealert is triggered.
Allowed values:
NoResourceReconciliationExample:
maintenance: NoResourceReconciliation -
- objectspec.settings
Module settings.
- stringspec.source
The source of the module it provided by one (otherwise empty).
- stringspec.updatePolicy
Module update policy.
Example:
updatePolicy: test-alpha - numberspec.version
Version of settings schema.
Example:
version: 1
- objectstatus
- stringstatus.message
Additional information
- stringstatus.version
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.
- objectspec
Required value
- stringspec.imageTag
Required value
Module container image tag, which will be pulled.
- booleanspec.rollback
Indicates whether the module release should be rollback after deleting mpo.
Default:
false - stringspec.scanInterval
Scan interval for checking the image digest. If the digest changes, the module is updated. Supported units:
h,m,s.Default:
15sPattern:
^(\d+h)?(\d+m)?(\d+s)?$
- objectstatus
- stringstatus.imageDigest
Digest of the module image.
- stringstatus.message
Details of the resource status.
- stringstatus.updatedAt
When the module was last updated.
- integerstatus.weight
Module weight.
Deprecated resource. Support for the resource might be removed in a later release.
Defines the configuration.
- objectspec
Required value
- stringspec.imageTag
Required value
Module container image tag, which will be pulled.
- booleanspec.rollback
Indicates whether the module release should be rollback after deleting ModulePullOverride.
Default:
false - stringspec.scanInterval
Scan interval for checking the image digest. If the digest changes, the module is updated. Supported units:
h,m,s.Default:
15sPattern:
^(\d+h)?(\d+m)?(\d+s)?$ - stringspec.source
Required value
Reference to the ModuleSource with the module.
- objectstatus
- stringstatus.imageDigest
Digest of the module image.
- stringstatus.message
Details of the resource status.
- stringstatus.updatedAt
When the module was last updated.
- integerstatus.weight
Module weight.
ModuleRelease
Short names: mr
Scope: Cluster
Version: v1alpha1
Defines the configuration for a Deckhouse release.
ModuleRelease resources are created by Deckhouse.
- objectspec
Required value
- stringspec.applyAfter
Time until which the release will be delayed.
- objectspec.changelog
Release’s changelog for the module.
- stringspec.moduleName
Required value
Module name.
- objectspec.requirements
Release dependencies, a set of requirements that must be met for Deckhouse Platform to run the module release.
- stringspec.requirements.deckhouse
Required Deckhouse version.
- stringspec.requirements.kubernetes
Required Kubernetes version.
- objectspec.requirements.modules
A list of other modules required for the module release. Ensure the modules are enabled.
- objectspec.update
Optional transition rules.
- array of objectsspec.update.versions
List of
from→totransition rules that allow skipping step-by-step updates. If the current installed module version (statusDeployed) is not lower thanfrom, and the cluster has a release whose version matchesto, the controller will skip intermediate releases and update the module to the version fromto. Thetovalue can specify a minor line (X.Y— the latest availableX.Y.Zwill be selected). The rule is specified in the constrained release — the one whose version matchesto.- stringspec.update.versions.from
Required value
The minimum version from which the transition is allowed (format
X.Y). - stringspec.update.versions.to
Required value
The end version of the range — a minor line (
X.Y).
- stringspec.version
Required value
Module version.
Example:
version: v1.0.0 - integerspec.weight
Module weight (priority).
- objectstatus
- booleanstatus.approved
Status indicating that the release is ready for deployment. For the Manual update mode only (
update.mode: Manual). - stringstatus.message
Detailed status or error message.
- stringstatus.phase
Current status of the release.
Allowed values:
Pending,Deployed,Superseded,Suspended,Skipped,Terminating - stringstatus.pullDuration
Module loading duration.
- integerstatus.size
Size of the module image.
- stringstatus.transitionTime
Time of release status change.
ModuleSettingsDefinition
Scope: Cluster
Version: v1alpha1
It displays module settings. Defines a list of module settings versions.
- objectspec
Required value
Specification of the module settings.
- array of objectsspec.versions
List of module settings versions. Each version includes a name and a schema.
- array of objectsspec.versions.conversions
List of conversion rules for this version.
A single conversion rule with expressions and descriptions.
- objectspec.versions.conversions.descriptions
Localized descriptions of the conversion.
- stringspec.versions.conversions.descriptions.en
English description of the conversion.
- stringspec.versions.conversions.descriptions.ru
Russian description of the conversion.
- array of stringsspec.versions.conversions.expr
Array of jq expressions to transform settings.
- stringspec.versions.name
Required value
Module settings version.
- objectspec.versions.schema
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>"
- objectspec
Required value
- objectspec.registry
Required value
- stringspec.registry.ca
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.
- stringspec.registry.dockerCfg
Container registry access token in Base64. If using anonymous access to the container registry, do not fill in this field.
- stringspec.registry.repo
Required value
URL of the container registry.
Example:
repo: registry.example.io/deckhouse/modules - stringspec.registry.scheme
Protocol to access the registry.
Default:
HTTPSAllowed values:
HTTP,HTTPS
- stringspec.releaseChannelDeprecated
Desirable default release channel for modules in the current source.
- stringspec.scanInterval
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:
30mPattern:
^(\d+h)?(\d+m)?(\d+s)?$Examples:
scanInterval: 5mscanInterval: 1hscanInterval: 6h30m
- objectstatus
- stringstatus.message
- array of objectsstatus.modules
The list of modules available from the source and their update policies.
- stringstatus.modules.checksum
The module checksum.
- stringstatus.modules.error
The module processing error.
- stringstatus.modules.name
The module name.
- booleanstatus.modules.overridden
If ModulePullOverride for this module exists.
- stringstatus.modules.policy
The module policy name.
- stringstatus.modules.pullError
The module pull error.
- stringstatus.modules.version
The module version.
- integerstatus.modulesCount
The number of modules available.
- stringstatus.phase
The current phase.
Allowed values:
Active,Terminating - stringstatus.syncTime
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'
- objectspec
Required value
- stringspec.releaseChannel
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:
StableAllowed values:
Alpha,Beta,EarlyAccess,Stable,RockSolid,Lts - objectspec.update
Required value
Update settings for target modules.
- stringspec.update.mode
Modules version update mode (release change).
-
AutoPatch— automatic update mode for patch releases.To change a minor version (for example, from
v1.15.*tov1.16.*), confirmation is required.A patch version update (for example, from
v1.16.1tov1.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.*tov1.16.*) and patch version updates (for example, fromv1.16.1tov1.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:
AutoAllowed values:
Auto,Manual,AutoPatch -
- array of objectsspec.update.windows
Modules update timetable.
- array of stringsspec.update.windows.days
The days of the week on which the update window is applied.
Examples:
days: Mondays: Wed- stringElement of the array
Day of the week.
Allowed values:
Mon,Tue,Wed,Thu,Fri,Sat,SunExample:
Mon
- stringspec.update.windows.from
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' - stringspec.update.windows.to
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'
- objectspec
Required value
- objectspec.moduleReleaseSelector
Required value
Selects target modules to apply update settings to.
- objectspec.moduleReleaseSelector.labelSelector
Required value
Label-selector-based filter to match target modules.
If both
matchExpressionsandmatchLabelsparameters are set, their requirements are ANDed together — they must all be satisfied in order to match. If multiplematchExpressionconditions are provided, they all must be satisfied in order to match.- array of objectsspec.moduleReleaseSelector.labelSelector.matchExpressions
An array of set-based expressions.
- stringspec.moduleReleaseSelector.labelSelector.matchExpressions.key
Required value
A label name.
- stringspec.moduleReleaseSelector.labelSelector.matchExpressions.operator
Required value
A comparison operator.
Allowed values:
In,NotIn,Exists,DoesNotExist - array of stringsspec.moduleReleaseSelector.labelSelector.matchExpressions.values
A label value.
- objectspec.moduleReleaseSelector.labelSelector.matchLabels
A number of equality-based label filters.
Example:
matchLabels: source: deckhouse module: deckhouse-admin
- stringspec.releaseChannel
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:
StableAllowed values:
Alpha,Beta,EarlyAccess,Stable,RockSolid - objectspec.update
Required value
Update settings for target modules.
- stringspec.update.mode
Modules version update mode (release change).
-
AutoPatch— automatic update mode for patch releases.To change a minor version (for example, from
v1.15.*tov1.16.*), confirmation is required.A patch version update (for example, from
v1.16.1tov1.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.*tov1.16.*) and patch version updates (for example, fromv1.16.1tov1.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:
AutoPatchAllowed values:
Auto,Manual,Ignore,AutoPatch -
- array of objectsspec.update.windows
Modules update timetable.
- array of stringsspec.update.windows.days
The days of the week on which the update window is applied.
Examples:
days: Mondays: Wed- stringElement of the array
Day of the week.
Allowed values:
Mon,Tue,Wed,Thu,Fri,Sat,SunExample:
Mon
- stringspec.update.windows.from
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' - stringspec.update.windows.to
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
- objectspec
Required value
Package repository configuration.
- objectspec.registry
Required value
Access parameters for the container registry where the package repository is located.
- stringspec.registry.ca
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>" - stringspec.registry.dockerCfg
Container registry access configuration in
~/.docker/config.jsonformat, encoded in Base64.Leave this field empty for anonymous access.
Example:
dockerCfg: "<base64 encoded credentials>" - stringspec.registry.login
Username for authenticating to the container registry.
Example:
login: admin - stringspec.registry.password
Password for authenticating to the container registry.
Example:
password: "<password>" - stringspec.registry.repo
Required value
Address of the package repository in the container registry.
Example:
repo: registry.example.io/packages - stringspec.registry.scheme
Protocol used to access the package repository, for example,
https.Example:
scheme: https
- stringspec.scanInterval
Interval between automatic scans of the package repository for discovering new packages and versions.
Default:
6hPattern:
^(\d+h)?(\d+m)?(\d+s)?$Examples:
scanInterval: 5mscanInterval: 1hscanInterval: 6h30m
- objectstatus
Current state of the package repository.
- array of objectsstatus.conditions
Conditions reflecting the current state of the package repository.
Condition reflecting an aspect of the current state of the package repository.
- stringstatus.conditions.lastTransitionTime
Required value
Time when the condition status last changed.
- stringstatus.conditions.message
Required value
Message with additional information about the condition.
May be empty.
Maximum length:
32768 - integerstatus.conditions.observedGeneration
Value of
.metadata.generationfor which the condition was set.Indicates whether the condition corresponds to the current generation of the instance.
Allowed values:
0 <= X - stringstatus.conditions.reason
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 - stringstatus.conditions.status
Required value
Condition status.
Allowed values:
True,False,Unknown - stringstatus.conditions.type
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
- stringstatus.lastChangeTime
Time of the last scan that discovered at least one new package version.
If no new versions are discovered, the value is not updated.
- integerstatus.lastNewVersions
Number of new package versions discovered during the last scan.
Equals
0if no new versions were discovered. - stringstatus.lastScanTime
Time of the last successfully completed scan.
If a scan fails, the value is not updated, and the error is reflected in the
LastScanSucceededcondition. - stringstatus.message
Message with additional information about the state of the package repository.
- array of objectsstatus.packages
List of packages available in the repository.
- stringstatus.packages.name
Required value
Package name.
- stringstatus.packages.type
Required value
Package type.
- integerstatus.packagesCount
Total number of packages in the repository.
- stringstatus.phase
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
- objectspec
Required value
Package repository operation parameters.
- stringspec.packageRepositoryName
Required value
Name of the package repository for which the operation is performed.
Example:
packageRepositoryName: deckhouse - stringspec.type
Required value
Operation type.
Allowed values:
Update - objectspec.update
Update operation parameters.
- booleanspec.update.fullScan
Indicates whether to perform a full scan of the package repository.
- stringspec.update.timeout
Operation timeout.
Example:
timeout: 5m
- objectstatus
Current state of the package repository operation.
- stringstatus.completionTime
Time when the operation completed.
- array of objectsstatus.conditions
Conditions reflecting the current state of the operation.
The operation phase is determined by the
Completedcondition: while its status isFalse, the operation is in one of the intermediate phases (DiscoverorProcessing). ATruestatus indicates that the operation has completed with theScanSucceededorScanFailedreason.Condition reflecting an aspect of the current state of the operation.
- stringstatus.conditions.lastTransitionTime
Required value
Time when the condition status last changed.
- stringstatus.conditions.message
Required value
Message with additional information about the condition.
Maximum length:
32768 - integerstatus.conditions.observedGeneration
Value of
.metadata.generationfor which the condition was set.Indicates whether the condition corresponds to the current generation of the instance.
Allowed values:
0 <= X - stringstatus.conditions.reason
Required value
Programmatic identifier indicating the reason for the last condition status change.
For the
Completedcondition, possible values areDiscover,Processing,ScanSucceeded, andScanFailed.Pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$Length:
1..1024Examples:
reason: Discoverreason: Processingreason: Succeededreason: Failed - stringstatus.conditions.status
Required value
Condition status.
Allowed values:
True,False,Unknown - stringstatus.conditions.type
Required value
Condition type in CamelCase or in the format
foo.example.com/CamelCase.This resource uses the
Completedcondition, 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
- objectstatus.packages
Information about packages processed during the operation.
- array of objectsstatus.packages.discovered
Packages discovered during the operation and awaiting processing.
The list is empty after the operation completes.
- stringstatus.packages.discovered.name
Required value
Name of the discovered package.
- array of objectsstatus.packages.failed
Packages that could not be processed.
- array of objectsstatus.packages.failed.errors
Required value
Errors that occurred while processing the package.
- stringstatus.packages.failed.errors.message
Required value
Error message.
- stringstatus.packages.failed.errors.version
Required value
Package version for which the error occurred.
- stringstatus.packages.failed.name
Required value
Name of the package that could not be processed.
- integerstatus.packages.newVersionsOverall
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.
- array of objectsstatus.packages.processed
Successfully processed packages.
- integerstatus.packages.processed.foundVersions
Number of package versions discovered during the operation.
- stringstatus.packages.processed.name
Required value
Name of the processed package.
- integerstatus.packages.processed.newVersions
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.
- stringstatus.packages.processed.type
Package type.
- integerstatus.packages.processedOverall
Total number of processed packages.
- integerstatus.packages.total
Total number of discovered packages.
- stringstatus.startTime
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>"
- stringapiVersion
Version of the Deckhouse API.
Allowed values:
dhctl.deckhouse.io/v1 - stringkind
Allowed values:
SSHConfig - booleanlegacyMode
Switch to legacy SSH mode (clissh).
- booleanmodernMode
Switch to modern SSH mode (gossh).
- array of objectssshAgentPrivateKeys
- stringsshAgentPrivateKeys.key
Required value
Contents of the private SSH key.
This field does not support passing a certificate. To authenticate with a certificate in
gosshmode, load the key together with its certificate into an ssh-agent accessible to dhctl throughSSH_AUTH_SOCK. This method is unavailable whenlegacyMode: true. - stringsshAgentPrivateKeys.passphrase
Password for SSH key.
- stringsshBastionHost
SSH bastion host.
- stringsshBastionPassword
A password for the bastion user.
- integersshBastionPort
Port of SSH bastion.
- stringsshBastionUser
Username for bastion.
- stringsshExtraArgs
Additional arguments for SSH connection.
- integersshPort
SSH port.
- stringsshUser
SSH username.
- stringsudoPassword
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
- stringapiVersion
Required value
Version of the Deckhouse API.
Allowed values:
dhctl.deckhouse.io/v1 - stringhost
Required value
Host.
- stringkind
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
- stringapiVersion
Required value
Version of the Deckhouse API.
Allowed values:
deckhouse.io/v1,deckhouse.io/v1alpha1 - array of stringsinternalNetworkCIDRs
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- stringElement of the array
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]))$
- stringkind
Required value
Allowed values:
StaticClusterConfiguration