Set up your system for Embedded Cluster installation

This guide outlines the necessary steps to prepare your environment for the installation of the Embedded Cluster. Follow the instructions below to ensure that your system is properly configured and fully ready for the installation process.

System requirements summary Copied

Requirement Details
Operating system Linux
Architecture x86-64
Init system systemd
Memory Refer to the Resources and hardware requirements
CPU cores Refer to the Resources and hardware requirements
Disk write latency

Ensure the disk’s P99 write latency does not exceed 10 ms to support etcd stability

For detailed information on disk write latency requirements for etcd, see the Disks section
Data directory space

At least 40Gi of total space and should not exceed 80% usage

For air-gapped, data storage should have at least three times the size of the airgap bundle and should not exceed 80% usage
Default data directory By default, the data directory is set to /var/lib/embedded-cluster
Custom data directory Use the --data-dir flag with the Embedded Cluster install command to change the default directory

Directories created by Embedded Cluster Copied

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

Directories and paths
  • /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 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.

Data directory Copied

The data directory is a necessary component of the ITRS Analytics application, containing both application data and logs. The allocated disk space for this directory must correspond to the t-shirt size chosen during deployment (for example, small, medium, large). For more information, see Resources and hardware requirements.

Default data directory Copied

By default, the data directory is set to /var/lib/embedded-cluster. If the default is used, ITRS Analytics will share disk space to other non-ITRS applications using the /var/lib/ or /var partition.

Custom data directory Copied

To configure a custom data directory path during installation, use the --data-dir flag with the Embedded Cluster installation command.

Notes and limitations Copied

The following constraints apply when using or configuring the data directory:

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.

Port Protocol Service
2379 TCP etcd
7443 TCP Kubernetes Metrics Server
9099 TCP
10248 TCP
10257 TCP Kubernetes controller manager
10259 TCP Kubernetes scheduler

Ports for inter-node communication Copied

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

Port Protocol Service
2380 TCP etcd peer
4789 UDP VXLAN
6443 TCP Kubernetes API Server
9091 TCP
9443 TCP
10249 TCP kube-proxy metrics
10250 TCP
10256 TCP kube-proxy health check

Additional services Copied

Port Protocol Service
53 UDP/TCP DNS resolution
9333 TCP SeaweedFS (HA mode)

Port for Admin Console Copied

Port Protocol
30000 TCP

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 by running the --admin-console-port flag with the Embedded Cluster install command. For example:

sudo ./itrs-analytics install --license license.yaml --admin-console-port=20000

Port for Local Artifact Mirror (LAM) Copied

Port Protocol
50000 TCP

If port 50000 is already in use, you can choose a different port for the LAM during installation by running the --local-artifact-mirror-port flag with the Embedded Cluster install command. For example:

sudo ./itrs-analytics install --license license.yaml --local-artifact-mirror-port=40000

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.

Consider important aspects of the data directory, including storage capacity and supported configurations.

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 check 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:

["ITRS Analytics"] ["User Guide", "Technical Reference"]

Was this topic helpful?