Skip to content

Terminology

This page is an attempt to demystify acronyms, terminology and concepts encountered in this project.

Cluster

This project mostly talks about a kubernetes cluster. Not to be confused with Flamenco Worker Tags. A kubernetes cluster is a group of compute nodes that kubernetes workloads can be scheduled and run on.

Flamenco Worker Tag

This is a group abstraction in Flamenco v3.3+ to group Workers together under arbitary groups. There is also a non-cluster group of those Workers that do not belong to any Flamenco Worker Tag.

Gateway Device

In this documentation, the cluster uses a RaspberryPi as the Gateway Device to host a range of services including a Gateway Server. The RaspberryPi is not fast to provisionbut it is a great low-powered device capable of hosting ecosystem services.

The Gateway Device also acts as a Network Gateway routing traffic between Home and Cluster networks.

NFS Server

The Flamenco project states the shared file service should be fast and file-based (not object based). So NFS is a natural and commonly found solution.

The Gateway Device runs a NFS Server although it is recommended to use a dedicated NAS or NFS Server running from reliable storage.

PXE Ubuntu Node Installer

The k8s control-plane and worker nodes are built using PXE Ubuntu installer. You do not have to use PXE Ubuntu Installer. It is possible to simply attach a pre-installed Ubuntu machine to the network and this is also documented in this project.

WOL (Wake On Lan)

The cluster subnet uses Wake-On-Lan (WOL) to power on the nodes within the cluster.


Documentation Conventions

Comment Boxes

Question

Question boxes discuss alternatives or explainations for a design choice or configuration option.

Tip

Tip boxes are things to keep in mind about how a service or technology is being applied or deployed.

Notice

Notice boxes highlight things not to overlook or to pay extra attention.