Skip to main content
Version: v4.12 (LTS)

Platform glossary

This page contains definitions for common terms used throughout the platform documentation.

Access Key

A secure credential in the platform that allows programmatic access to platform resources and API endpoints.

Related terms: The Platform, User

Admission Control

A Kubernetes feature that intercepts requests to the API server prior to persistence of the object, allowing for validation, mutation, or rejection of requests based on configured policies.

Related terms: API Server, Control Plane

API Server

The core component of Kubernetes that exposes the Kubernetes API. It is the front-end for the Kubernetes control plane and handles all REST operations, validating and configuring data for API objects.

Related terms: Control Plane, rate-limiting

Auto Nodes

A vCluster feature that provisions private nodes and joins them to a cluster automatically, based on the cluster's resource needs. Auto Nodes requests capacity by node type from a node provider, such as a vMetal driver, and requires vCluster Platform.

Related terms: Private Nodes, Node type, Driver

Auto Sleep

A platform feature that allows clusters or namespaces to be paused when inactive, conserving resources and reducing costs.

Related terms: The Platform

Auto Sleep

A platform feature that allows clusters or namespaces to be paused when inactive, conserving resources and reducing costs.

Related terms: The Platform

BareMetalHost

The Metal3 driver's own record of one physical server, including its BMC connection details and provisioning state. Metal3 selects a BareMetalHost to satisfy a claim. It isn't the same as Machine, the driver-neutral inventory mirror, or NodeClaim, the claim itself.

Related terms: Machine, NodeClaim, Driver

BMC

Baseboard Management Controller. The out-of-band management interface on a physical server that a bare metal driver such as Metal3 uses to power-cycle, inspect, and reimage hardware.

Related terms: Driver

Capacity pool

The set of servers eligible for a given node type at a point in time. An instance of the node type waits while its capacity pool has no free server.

Related terms: Node type, Instance

Certified Stack

A StackTemplate distributed with vCluster Platform as part of a pinned, tested integration bundle. Certified Stack resources are view-only; copy one before customizing it.

Related terms: StackTemplate, StackInstance

Cluster template

A predefined configuration in the platform for creating clusters with consistent settings, policies, and resources.

Related terms: Template

Compaction

The process of removing superseded data from etcd to free up storage space. Regular compaction prevents etcd from running out of disk space.

Related terms: etcd, Defragmentation

Control Plane

The container orchestration layer that exposes the API and interfaces to define, deploy, and manage the lifecycle of containers. In vCluster, each cluster has its own control plane components.

Related terms: API Server, vCluster

Defragmentation

The process of releasing unused space in etcd's backend database after compaction. While compaction marks space as free, defragmentation reclaims it.

Related terms: etcd, Compaction

Driver

The vMetal integration that provisions and manages a specific infrastructure type, such as bare metal servers (Metal3, NICo) or virtual machines (KubeVirt). The NodeProvider resource is configured against one driver.

Related terms: Instance, Machine, Node type

etcd

A distributed key-value store that provides reliable storage for Kubernetes cluster data. In vCluster, etcd can be deployed externally or embedded within the vCluster pod.

Related terms: Control Plane

Instance

The customer-facing concept for one vMetal claim on a physical or virtual server. In the API, a NodeClaim represents the instance request and tracks its lifecycle. When the NodeClaim is deleted, the driver releases reusable infrastructure or destroys infrastructure created for the request.

Related terms: Server, NodeClaim, Node type, Driver, Machine

K0s

A lightweight, certified Kubernetes distribution that can be used in clusters as an alternative to K3s or standard Kubernetes.

Related terms: K3s, K8s

K3s

A lightweight, certified Kubernetes distribution often used as the default distribution for clusters due to its minimal resource requirements and fast startup time.

Related terms: K8s, K0s

K8s

The standard Kubernetes distribution that can be used in clusters, offering full compatibility with upstream Kubernetes features.

Related terms: K3s, K0s

Machine

A read-only mirror of one physical machine in a bare metal provider's inventory. The platform's inventory sync creates, updates, and deletes it. Users can change metadata that isn't platform-owned, but they can't change its spec or status. It's distinct from an instance, which represents a claim on capacity, and from a BareMetalHost, which is the Metal3 driver's own record of the same server.

Related terms: Instance, BareMetalHost, Server, NodeClaim, Driver

Namespace

A Kubernetes namespace that can be managed by the platform, providing isolation for resources within a cluster.

Related terms: Project

Node type

An administrator-published offering, also called a machine type, that groups eligible servers by label selector and sets their provisioning defaults. These include OS image, SSH keys, network configuration, and cost. Tenant assignment and the node type's machine allocation policy further limit which servers a tenant's instances can use. A request by node type lets the driver select eligible capacity.

Related terms: Capacity pool, Driver, NodeClaim, Instance

NodeClaim

The Kubernetes resource that implements an instance request and tracks its lifecycle. A cluster or administrator requests capacity matching a node type, and the platform creates a NodeClaim to track scheduling, provisioning, and joining.

Related terms: Instance, Node type

Private Nodes

A vCluster feature that joins dedicated worker nodes to a single cluster, so its workloads don't share nodes with other tenants or with the control plane cluster. The cluster's control plane still runs on the control plane cluster. vMetal can supply these nodes as instances.

Related terms: Auto Nodes, Instance, Control plane cluster

Project

A logical grouping of resources in the platform that provides team isolation and resource quotas. Projects help organize clusters and namespace resources.

Related terms: The Platform, Team

Server

The physical or virtual host that a driver provisions and an instance claims, such as a BareMetalHost under the Metal3 driver. A server's identity is independent of any single instance. It's registered once, then claimed, released, and claimed again many times over its life in the fleet.

Related terms: Instance, Machine, Driver, Capacity pool

Stack task

One node in a Stack dependency graph. A task creates either an AppInstance or an ArgoCDApplication and can wait for dependencies, capture outputs, and pass values to later tasks.

Related terms: StackTemplate, StackInstance

StackInstance

A project-scoped platform resource that deploys an inline or referenced stack definition to one cluster or control plane cluster and reports aggregate and per-task status.

Related terms: StackTemplate, Stack task, Cluster, Control plane cluster

StackTemplate

A cluster-scoped, reusable platform resource that defines parameters and a dependency graph of App or Argo CD application tasks. A StackInstance resolves and deploys the definition.

Related terms: StackInstance, Stack task, Certified Stack, Template

Team

A group of users in the platform with shared access to specific projects and resources.

Related terms: Project, User

Template

A reusable configuration pattern in the platform that defines the settings and resources for creating clusters, namespaces, applications, or stacks.

Related terms: The Platform, Cluster template, StackTemplate

The Platform

The vCluster Platform that provides management, access control, and operational features for clusters across multiple control plane clusters.

Related terms: Project

User

An individual account in the platform with specific access permissions to projects and resources.

Related terms: Team

vMetal

The machine layer of vCluster Platform. vMetal provisions and manages physical and virtual machines through a common instance model, whether or not they run Kubernetes. It boots bare metal servers over the network, installs an operating system, configures networking, and tracks which servers are claimed and which are free to reuse. Drivers such as Metal3, NICo, and KubeVirt supply the infrastructure.

Related terms: Instance, Server, Driver, Node type