README
¶
Deckhouse Kubernetes Platform is an Open Source platform for managing Kubernetes clusters in a fully automatic and uniform fashion. It allows you to create homogeneous Kubernetes clusters anywhere and fully manages them. It supplies all the add-ons you need for auto-scaling, observability, security, and service mesh. It comes in Enterprise Edition (EE) and Community Edition (CE).
Main features
- NoOps: system software on the nodes, Kubernetes core software, Kubernetes platform components are automatically managed.
- SLA by design: availability can be guaranteed even without direct access to your infrastructure.
- Completely identical and infrastructure-agnostic clusters. Deploy on a public cloud of your choice (AWS, GCP, Microsoft Azure, OVH Cloud), self-hosted cloud solutions (OpenStack and vSphere), and even bare-metal servers.
- 100 % vanilla Kubernetes based on an upstream version of Kubernetes.
- Easy to start: you need a couple of CLI commands and 8 minutes to get production-ready Kubernetes.
- A fully-featured platform. Many features (check the diagram below) — carefully configured & integrated — are available right out of the box.
Deckhouse Kubernetes Platform has passed the CNCF Certified Kubernetes Conformance Program certification for Kubernetes 1.26—1.30.
Platform features across layers
The diagram below illustrates how Deckhouse Kubernetes Platform features are distributed across different layers of the platform — from infrastructure to the control plane and cluster nodes.
CE vs. EE
While Deckhouse Kubernetes Platform CE is available free as an Open Source, EE is a commercial version of the platform that can be purchased with a paid subscription. EE's source is also open, but it's neither Open Source nor free to use.
EE brings many additional features that extend the basic functionality provided in CE. They include OpenStack & vSphere integration, Istio service mesh, multitenancy, enterprise-level security, BGP support, instant autoscaling, local DNS caching, and selectable timeframe for the platform's upgrades.
Deckhouse Kubernetes Platform CE is freely available for everyone. Deckhouse Kubernetes Platform EE can be accessed via 30-days tokens issued via Deckhouse website.
Architecture
Deckhouse Kubernetes Platform follows the upstream version of Kubernetes, using that as a basis to build all of its features and configurations on. The added functionality is implemented via two building blocks:
- shell-operator — to create Kubernetes operators (please check the KubeCon NA 2020 talk for details);
- addon-operator — to pack these operators into modules and manage them.
Trying Deckhouse Kubernetes Platform
Please, refer to the project's Getting started to begin your journey with Deckhouse Kubernetes Platform. Choose the cloud provider or bare-metal option for your infrastructure and follow the relevant step-by-step instructions to deploy your first Deckhouse Kubernetes cluster.
If anything works in an unexpected manner or you have any questions, feel free to contact us via GitHub Issues / Discussions or reach a wider community of Deckhouse users in Telegram and other resources.
Online community
Besides using the standard GitHub features to contribute and collaborate, you can also join our Telegram chats. These are a great place to ask questions, discuss Deckhouse Kubernetes Platform and our other products, as well as connect with the user community and the Deckhouse engineering team. The chats are available in English and Russian.
Directories
¶
| Path | Synopsis |
|---|---|
|
deckhouse-controller
|
|
|
cmd/deckhouse-controller
command
Code generated by "register.go" DO NOT EDIT.
|
Code generated by "register.go" DO NOT EDIT. |
|
internal/app
Package app is deckhouse's single entry point for application configuration: constants, settings, CLI flags and environment variables.
|
Package app is deckhouse's single entry point for application configuration: constants, settings, CLI flags and environment variables. |
|
internal/crd
Package crd installs CustomResourceDefinitions bundled with Deckhouse packages (modules) and reports the GroupVersionKinds of Deckhouse-managed CRDs present in the cluster.
|
Package crd installs CustomResourceDefinitions bundled with Deckhouse packages (modules) and reports the GroupVersionKinds of Deckhouse-managed CRDs present in the cluster. |
|
internal/metrics
Package metrics provides centralized metric label key constants for deckhouse-controller.
|
Package metrics provides centralized metric label key constants for deckhouse-controller. |
|
internal/packages/apps
Package apps provides the Application type representing a running package instance.
|
Package apps provides the Application type representing a running package instance. |
|
internal/packages/grants
Package grants resolves per-project cluster resource grants (multitenancy-manager AvailableClusterResource) so that Application package settings fields tagged with x-deckhouse-grantable-resource can be defaulted and validated against what a project may use.
|
Package grants resolves per-project cluster resource grants (multitenancy-manager AvailableClusterResource) so that Application package settings fields tagged with x-deckhouse-grantable-resource can be defaulted and validated against what a project may use. |
|
internal/packages/nelm/drift
Package monitor provides resource monitoring for Helm releases deployed via nelm.
|
Package monitor provides resource monitoring for Helm releases deployed via nelm. |
|
internal/packages/runtime/debug
Package debug provides a Unix socket-based HTTP server and client for runtime debugging and inspection.
|
Package debug provides a Unix socket-based HTTP server and client for runtime debugging and inspection. |
|
internal/packages/runtime/hookevent
Package hookevent provides event handling for Kubernetes and schedule events.
|
Package hookevent provides event handling for Kubernetes and schedule events. |
|
internal/packages/runtime/tasks/globalrun
Package globalrun provides the global node's unit of work: run the global BeforeAll hooks, ensure the CRDs of every enabled module, then publish the enabled set and the discovered CRD capabilities into global values, before any module converges behind the global barrier.
|
Package globalrun provides the global node's unit of work: run the global BeforeAll hooks, ensure the CRDs of every enabled module, then publish the enabled set and the discovered CRD capabilities into global values, before any module converges behind the global barrier. |
|
internal/packages/schedule/rule
Package rule models the single enable/disable signal type the scheduler folds to decide whether a package may run.
|
Package rule models the single enable/disable signal type the scheduler folds to decide whether a package may run. |
|
internal/packages/schedule/rule/bundle
Package bundle provides a module floor rule: it enables a module when the cluster's active bundle is one that enables it in the active edition, and soft-disables it otherwise.
|
Package bundle provides a module floor rule: it enables a module when the cluster's active bundle is one that enables it in the active edition, and soft-disables it otherwise. |
|
internal/packages/schedule/rule/dynamic
Package dynamic provides the module enablement intent rule: the highest- precedence enablement signal a module carries, folding the external enable/disable signals (explicit ModuleConfig intent and the deprecated global-hook dynamic enable).
|
Package dynamic provides the module enablement intent rule: the highest- precedence enablement signal a module carries, folding the external enable/disable signals (explicit ModuleConfig intent and the deprecated global-hook dynamic enable). |
|
internal/packages/schedule/rule/script
Package script models a module's enabled script as a scheduler rule.
|
Package script models a module's enabled script as a scheduler rule. |
|
pkg/apis/deckhouse.io/v1alpha1
+kubebuilder:object:generate=true +groupName=deckhouse.io
|
+kubebuilder:object:generate=true +groupName=deckhouse.io |
|
pkg/apis/deckhouse.io/v1alpha2
+kubebuilder:object:generate=true +groupName=deckhouse.io
|
+kubebuilder:object:generate=true +groupName=deckhouse.io |
|
pkg/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
pkg/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
pkg/client/clientset/versioned/typed/deckhouse.io/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
pkg/client/clientset/versioned/typed/deckhouse.io/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
pkg/client/clientset/versioned/typed/deckhouse.io/v1alpha2
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
pkg/client/clientset/versioned/typed/deckhouse.io/v1alpha2/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
pkg/controller/packages/module-package-version
Package modulepackageversion reconciles ModulePackageVersion resources by fetching package metadata from the registry and promoting drafts to ready.
|
Package modulepackageversion reconciles ModulePackageVersion resources by fetching package metadata from the registry and promoting drafts to ready. |
|
pkg/envconfig
Package envconfig owns the environment-variable contract between the deckhouse-controller deployment manifest and the addon-operator / shell-operator runtime libraries.
|
Package envconfig owns the environment-variable contract between the deckhouse-controller deployment manifest and the addon-operator / shell-operator runtime libraries. |
|
dhctl
module
|
|
|
ee
|
|
|
go_lib
|
|
|
cloud-data
module
|
|
|
cloud-provider
module
|
|
|
configtools/conversion
module
|
|
|
controlplane
module
|
|
|
dependency/k8s/drain
module
|
|
|
dependency/vsphere
module
|
|
|
dhctl-provider-protocol
module
|
|
|
log
module
|
|
|
registry
module
|
|
|
registry-bundle
module
|
|
|
registry-packages-proxy
module
|
|
|
modules
|
|
|
015-admission-policy-engine/charts/constraint-templates/tests/tools/constraint_testgen
command
constraint_testgen: verify ConstraintTestProfile vs test_suite; generate from ConstraintTestMatrix.
|
constraint_testgen: verify ConstraintTestProfile vs test_suite; generate from ConstraintTestMatrix. |
|
040-control-plane-manager/hooks
Code generated by "tools/audit_policy.go" DO NOT EDIT.
|
Code generated by "tools/audit_policy.go" DO NOT EDIT. |
|
040-node-manager/hooks/internal/capi/v1beta1
Package v1beta1 contains the v1beta1 API implementation.
|
Package v1beta1 contains the v1beta1 API implementation. |
|
030-cloud-provider-dvp/pkg
module
|
|
|
pkg
|
|
|
crd-enricher
module
|
|
|
log
module
|
|
|
metrics-storage
module
|
|
|
registry
module
|
|
|
testing
|
|
|
controller/reconcilertest
Package reconcilertest is a reusable test framework for controller-runtime reconcilers.
|
Package reconcilertest is a reusable test framework for controller-runtime reconcilers. |
|
library
Code generated by "tools/images_tags.go" DO NOT EDIT.
|
Code generated by "tools/images_tags.go" DO NOT EDIT. |
|
tools
|
|
|
regcopy
module
|