Set up your system for Embedded Cluster installation

This guide helps you get everything ready before installing Embedded Cluster. Follow the steps below to make sure your system is set up correctly and ready to go.

System requirements summary Copied

Expand table

Directories created by Embedded Cluster Copied

The cluster and its components will automatically create files and directories in the following paths:

Directories and files

• /etc/cni
• /etc/k0s
• /opt/cni
• /opt/containerd
• /run/calico
• /run/containerd
• /run/k0s
• /sys/fs/cgroup/kubepods
• /sys/fs/cgroup/system.slice/containerd.service
• /sys/fs/cgroup/system.slice/k0scontroller.service
• /usr/libexec/k0s
• /var/lib/calico
• /var/lib/cni
• /var/lib/containers
• /var/lib/kubelet
• /var/log/calico
• /var/log/containers
• /var/log/embedded-cluster
• /var/log/pods
• /usr/local/bin/k0s

Network access for online installations Copied

If you’re installing Embedded Cluster with an internet connection, make sure your system can connect to these websites:

• replicated.app
• proxy.replicated.com
• Or a custom domain provided by your company

k0s compatibility Copied

Embedded Cluster is built on k0s, so it inherits all k0s system requirements and external runtime dependencies.

Port requirements Copied

Correct port configuration is important for the operation of Embedded Cluster. These ports need to be accessible for both single-node and multi-node installations.

Ports for local processes Copied

These ports must be accessible to local processes on the same node. No firewall rules are required.

Expand table

Ports for inter-node communication Copied

The ports listed below are used for two-way communication between nodes.

• In multi-node setups, you must open these ports in the firewall to allow traffic between nodes.
• In single-node setups, these ports must still be available, even though no inter-node communication occurs.

Expand table

Additional services Copied

Expand table

Port for Admin Console Copied

Expand table

Note

Open port 30000/TCP in the firewall to allow end users to access the Admin Console. This port must also be reachable by any nodes joining the cluster. If port 30000 is already in use, you can specify a different port during installation. Refer to the Embedded Cluster Install Command Options for details.

Port for Local Artifact Mirror (LAM) Copied

Expand table

Note

If port 50000 is already in use, you can choose a different port for the LAM during installation. Refer to the Embedded Cluster Install Command Options for details.

Summary of setup and requirements Copied

Ensure your system meets the hardware, OS, and disk performance specifications.

Set up directories, confirm system services (like systemd), and verify available disk space.

Configure firewall rules or verify port availability for local and inter-node communication.

Make sure the system can reach necessary external domains like replicated.app.

Go through a final checklist to verify readiness for installation.

Execute the install command with optional flags for data directories and custom ports.

Ready to install Embedded Cluster Copied

Now that you’ve completed the Embedded Cluster installation checklist and prepared your system with all the required pre-installation steps, you’re ready to move forward.

Proceed to the installation process to deploy your Embedded Cluster:

• Install in an online embedded cluster
• Install in an air-gapped embedded cluster