Deckhouse Platform in a private environment

This guide focuses on deploying a Kubernetes cluster using Deckhouse in a private environment when there is no direct access to the container image registry or deb/rpm package repositories.

Installation in a private environment is generally similar to installation on bare metal. The only difference is in some additional settings.

Scheme of Deckhouse installation in a private environment:
Scheme of Deckhouse installation in a private environment

Installation process

You will need:

  1. Personal computer.

    The computer from which the installation will be performed. It is only needed to run the Deckhouse installer and will not be part of the cluster.

    Requirements:

    • OS: Windows 10+, macOS 10.15+, Linux (e.g. Ubuntu 18.04+, Fedora 35+);
    • installed docker to run the installer (here are the instructions for Ubuntu, macOS, Windows);

    • access to a proxy registry (read more about setting them up) or to a private container image registry containing Deckhouse images;
    • SSH key access to the node, the master node of the future cluster.
  2. Master-node (nodes).

    A server (physical server or virtual machine), the master node of the future cluster.

    During the installation, the Deckhouse installer running on the personal computer (section 1) will connect to that host via SSH, install necessary packages, configure control plane Kubernetes, and deploy Deckhouse.

    Note that master node-based installation is not currently supported.

    Requirements:

    • at least 4 CPU cores;
    • at least 8 GB of RAM;
    • at least 40 GB of disk space for the cluster and etcd data;
    • supported OS;

    • access to a proxy registry or to a private container image registry containing Deckhouse images;
    • access to a proxy server for downloading deb/rpm OS packages (if necessary);
    • SSH key access from the personal computer (section 1);
    • container runtime packages, such as containerd or docker, should not be installed on the node.
  3. Additional nodes (not required).

    Depending on the purpose of the cluster, you may need additional nodes, for example, worker nodes, dedicated nodes for monitoring, dedicated nodes for load balancers (frontend nodes), etc.

    Below are the minimum requirements for any node (node group):

    • supported OS;

    • access to a proxy registry or to a private container image registry containing Deckhouse images;
    • access to a proxy server for downloading deb/rpm OS packages (if necessary);
    • container runtime packages, such as containerd or docker, should not be installed on the node.

    Below are the minimum requirements for any node (node group) with the monitoring role (learn more):

    • at least 4 CPU cores;
    • at least 8 GB of RAM.

    By default, the default storage class defined in the cluster is used as storage for system components (or emptydir, if it is not defined). You can specify the storage class using the global parameter storageClass.

The presentation below is an overview of the actions that will be required to install Deckhouse Platform. While it’s totally fine to skip it, we recommend that you watch it to better understand the following steps.

Note that it’s only a brief, abstract overview. The specific actions and commands to execute will be given on the next steps.

Control presentation