Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update requirements #724

Merged
merged 4 commits into from
Feb 12, 2025
Merged

docs: update requirements #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14f71e8
docs: update requirements
fl64 Feb 11, 2025
c04097f
docs: fix link
fl64 Feb 11, 2025
a0e3ba9
editing
Feb 12, 2025
4ff10f8
editing
Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 116 additions & 22 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,133 @@ title: "Installation"
weight: 15
---

## DVP Requirements
> **Warning.** The platform components must be deployed on physical servers (bare-metal servers).
>
> Installation on virtual machines is allowed for demonstration purposes only, but nested virtualization must be enabled. If the platform is deployed on virtual machines, technical support will not be provided.
### Resource requirements:
## Platform scalability

The following minimum resources are recommended for infrastructure nodes, depending on their role in the cluster:
The platform supports the following configuration:

- Master node-4 CPUs, 8 GB of RAM, 60 GB of disk space on a fast disk (400+ IOPS);
- Worker node-the requirements are similar to those for the master node, but largely depend on the nature of the load running on the node (nodes).
- Maximum number of nodes: 1000.
- Maximum number of virtual machines: 50000.

> If you plan to use the virtualization module in a production environment, it is recommended to deploy it on physical servers. Deploying the module on virtual machines is also possible, but in this case you need to enable nested virtualization.
The platform has no other restrictions and is compatible with any hardware that is supported by [operating systems](#supported-os-for-platform-nodes) on which it can be installed.

### Requirements for platform nodes:
## Hardware Requirements

- Linux-based OS:
- CentOS 7, 8, 9
- Debian 10, 11, 12
- Rocky Linux 8, 9
- Ubuntu 18.04, 20.04, 22.04, 24.04
- Linux kernel version >= 5.7
- CPU with x86_64 c architecture with support for Intel-VT (vmx) or AMD-V (svm) instructions
1. A dedicated **machine for installation**.

## Installation
This machine will run the Deckhouse installer. For example, it can be an administrator's laptop or any other computer that is not intended to be added to the cluster. Requirements for this machine:

1. Deploy the Deckhouse Kubernetes Platform cluster by [instruction](https://deckhouse.io/products/kubernetes-platform/gs/).
- OS: Windows 10+, macOS 10.15+, Linux (Ubuntu 18.04+, Fedora 35+);
- Installed Docker Engine or Docker Desktop (instructions for [Ubuntu](https://docs.docker.com/engine/install/ubuntu/), [macOS](https://docs.docker.com/desktop/mac/install/), [Windows](https://docs.docker.com/desktop/windows/install/));
- HTTPS access to the container image registry at `registry.deckhouse.io`;
- SSH key-based access to the node that will serve as the **master node** of the future cluster;
- SSH key-based access to the node that will serve as the **worker node** of the future cluster (if the cluster will consist of more than one master node).

1. **Server for the master node**

There can be multiple servers running the cluster’s control plane components, but only one server is required at installation time. The others can be added later via node management mechanisms.

Requirements for a physical bare-metal server:

- Resources:
- CPU:
- x86_64 architecture;
- Support for Intel-VT (VMX) or AMD-V (SVM) instructions;
- At least 4 cores.
- RAM: At least 8 GB.
- Disk space:
- At least 60 GB;
- High-speed disk (400+ IOPS).
- OS [from the list of supported ones](#supported-os-for-platform-nodes):
- Linux kernel version `5.7` or newer.
- **Unique hostname** across all servers in the future cluster;
- Network access:
- HTTPS access to the container image registry at `registry.deckhouse.io`;
- Access to the package repositories of the chosen OS;
- SSH key-based access from the **installation machine** (see p.1);
- Network access from the **installation machine** (see p.1) on port `22322/TCP`.
- Required software:
- The `cloud-utils` and `cloud-init` packages must be installed (package names may vary depending on the chosen OS).
> **Warning.** The container runtime will be installed automatically, so do not pre-install any `containerd` or `docker` packages.
1. **Servers for worker nodes**

These nodes will run virtual machines, so the servers must have enough resources to handle the planned number of VMs. Additional disks may be required if you deploy a software-defined storage solution.

Requirements for a physical bare-metal server:

- Resources:
- CPU:
- x86_64 architecture;
- Support for Intel-VT (VMX) or AMD-V (SVM) instructions;
- At least 4 cores;
- RAM: At least 8 GB;
- Disk space:
- At least 60 GB;
- High-speed disk (400+ IOPS);
- Additional disks for software-defined storage;
- OS [from the list of supported ones](#supported-os-for-platform-nodes);
- Linux kernel version `5.7` or newer;
- **Unique hostname** across all servers in the future cluster;
- Network access:
- HTTPS access to the container image registry at `registry.deckhouse.io`;
- Access to the package repositories of the chosen OS;
- SSH key-based access from the **installation machine** (see p.1);
- Required software:
- The `cloud-utils` and `cloud-init` packages must be installed (package names may vary depending on the chosen OS).
> **Important.** The container runtime will be installed automatically, so do not pre-install any `containerd` or `docker` packages.
1. **Storage hardware**

Depending on the chosen storage solution, additional resources may be required. For details, refer to the section [Storage Management](/products/virtualization-platform/documentation/admin/platform-management/storage/sds/lvm-local.html).

## Supported OS for platform nodes

| Linux distribution | Supported versions |
| --------------------------- | ------------------------------- |
| CentOS | 7, 8, 9 |
| Debian | 10, 11, 12 |
| Ubuntu | 20.04, 22.04, 24.04 |

2. Enable the necessary modules.
## Supported guest operating systems

To store virtual machine data (virtual disks and images), you must enable one or more of the following modules according to the installation instructions:
The virtualization platform supports operating systems running on `x86` and `x86_64` architectures as guest operating systems. For correct operation in paravirtualization mode, `VirtIO` drivers must be installed to ensure efficient interaction between the virtual machine and the hypervisor.

Successful startup of the operating system is determined by the following criteria:

* correct installation and booting of the OS;
* uninterrupted operation of key components such as networking and storage;
* no crashes or errors during operation.

For Linux family operating systems it is recommended to use guest OS images with `cloud-init` support, which allows initializing virtual machines after their creation.

For Windows operating systems, the platform supports initialization using the built-in sysprep utility.

## Supported virtual machine configurations

Maximum number of cores supported: `254`
Maximum amount of RAM: `1024 GB`

## Supported Storage Systems

Virtual machines use `PersistentVolume` resources. To manage these resources and allocate disk space within the cluster, one or more supported storage systems must be installed:

| Storage System | Disk Location |
|---------------------------------------------|----------------------------|
| LVM (Logical Volume Manager) | Local |
| DRBD (Distributed Replicated Block Device) | Replicas on cluster nodes |
| Ceph Cluster | External storage |
| NFS (Network File System) | External storage |
| TATLIN.UNIFIED (Yadro) | External storage |

## Installation

1. Deploy the Deckhouse Kubernetes Platform cluster by [instruction](https://deckhouse.io/products/kubernetes-platform/gs/).

- [SDS-Replicated-volume](https://deckhouse.io/modules/sds-replicated-volume/stable/)
- [SDS-Local-volume](https://deckhouse.io/modules/sds-local-volume/stable/)
- [CSI-nfs](https://deckhouse.io/modules/csi-nfs/stable/)
- [CEPH-CSI](/documentation/v1/modules/031-ceph-csi/)
2. To store virtual machine data (virtual disks and images), you must enable one or more supported [storage](#supported-storage-systems).

3. [Set](https://kubernetes.io/docs/tasks/administer-cluster/change-default-storage-class/) default `StorageClass`.
4. Turn on the [console](https://deckhouse.io/modules/console/stable/) module, which will allow you to manage virtualization components through via UI (This feature is available only to users of the EE edition).
Expand Down
Loading
Loading