agent-forge-operator on contineroo.ch

Core Concepts

Mon, 01 Jan 0001 00:00:00 +0000

Architecture

agent-forge-operator is a demand-driven bridge between HyperShift Agent NodePools and vSphere inventory. It does not scale NodePools directly and it does not replace the hosted cluster autoscaler. It reacts to demand that HyperShift and CAPI already expressed through AgentMachine resources.

The reconciliation flow is:

The hosted cluster autoscaler changes HyperShift NodePool demand.
HyperShift and CAPI render AgentMachine and Machine resources.
Waiting AgentMachine resources report Ready=False with Reason=NoSuitableAgents.
VsphereAgentPool reconciliation plans required capacity from AgentMachine demand, existing Agents, owned VMs, and InfraEnv state.
A VsphereAgent request creates one vSphere VM.
The VM boots the InfraEnv discovery ISO and appears as an Assisted Installer Agent.
The operator prepares the Agent so the Agent CAPI provider can bind it to a Machine.

Demand

The operator watches CAPI AgentMachine objects for one HyperShift NodePool. It creates capacity only when an AgentMachine reports Ready=False with Reason=NoSuitableAgents.

Get Started

Mon, 01 Jan 0001 00:00:00 +0000

This tutorial walks through a first VsphereAgentPool and active VM reconciliation.

Before you begin

The following prerequisites are required:

A Kubernetes or OpenShift management cluster with agent-forge-operator installed.
HyperShift and Assisted Installer resources.
A hosted cluster that uses the Agent platform.
A NodePool for the hosted cluster.
CAPI AgentMachine and Machine objects rendered for that NodePool in the hosted control plane namespace.
An InfraEnv in the hosted cluster namespace with status.isoDownloadURL populated.
vSphere credentials that can upload the discovery ISO, create VMs, power on VMs, and destroy operator-owned VMs.

The examples use these names:

Installation

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through installing agent-forge-operator.

Prerequisites

Install Helm 3.
Kubernetes or OpenShift cluster.
HyperShift and Assisted Installer resources for Agent platform clusters.

Install agent-forge-operator

Helm repository

Add the containeroo Helm chart repository:

helm repo add containeroo https://charts.containeroo.ch

Update the Helm chart repository:

helm repo update

Custom Resource Definitions

The Helm chart includes the VsphereAgent and VsphereAgentPool CRDs in the chart crds/ directory. Helm installs CRDs on first install, but does not upgrade or delete CRDs during normal chart upgrades.

API Reference

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

agent-forge.containeroo.ch/v1alpha1

agent-forge.containeroo.ch/v1alpha1

Package v1alpha1 contains API Schema definitions for the agent-forge.containeroo.ch v1alpha1 API group.

Resource Types:

AgentBindingSpec

(Appears on: VsphereAgentPoolSpec)

AgentBindingSpec describes how a discovered Assisted Installer Agent should be made consumable by the Hypershift Agent NodePool.

Field	Description
`role` string	Role is the Hypershift NodePool role label value to apply to discovered Agents. For worker pools this is normally “worker”.
`labels` map[string]string	Labels are required on a discovered Agent before the Agent CAPI provider can bind it to an AgentMachine. These should match the NodePool spec.platform.agent.agentLabelSelector labels.