OpenShift Agent Install Helper

Welcome to the OpenShift Agent Install Helper documentation. This project provides utilities and automation to simplify OpenShift Agent-based installations across various environments.

Overview

The OpenShift Agent Install Helper provides automation and configuration management to simplify the usage of the OpenShift Agent-based Installer. It supports:

• Bare metal installations
• VMware vSphere deployments
• Platform-agnostic (none) deployments
• Single-Node OpenShift (SNO)
• Three-node compact clusters
• Standard HA configurations

Key Components

• Ansible playbooks for manifest generation (playbooks/)
• ISO creation utilities (get-rhcos-iso.sh)
• Network configuration templates (examples/)
• BMC management tools (scripts/)
• Validation scripts (e2e-tests/)
• Example configurations (examples/)

Prerequisites

• RHEL/CentOS system for installation host
• OpenShift CLI Tools (./download-openshift-cli.sh)
• NMState CLI (dnf install nmstate)
• Ansible Core (dnf install ansible-core)
• Red Hat OpenShift Pull Secret
• Additional pull secrets for disconnected registries (if needed)

Supported Architectures

CPU Architecture	Connected Installation	Disconnected Installation
x86_64	✓	✓
ARM64	✓	✓
ppc64le	✓	✓
s390x	✓	✓

Key Features

• Flexible server boot options
• Offline installation support
• Air-gapped environment support
• Multiple platform support (baremetal, vsphere, none)
• FIPS compliance capabilities
• Static and DHCP networking support
• Advanced networking configurations (bonds, VLANs, SR-IOV)

Documentation Structure

Getting Started

• Installation Guide
• Configuration Guide
• Contributing Guide
• Architecture Decisions

Installation and Configuration

• Installation Guide
• Configuration Guide
• Disconnected Installation
• Identity Management

Networking and Infrastructure

• Network Configuration Guide
• Advanced Networking
• BMC Management
• Infrastructure Setup

Testing and Validation

• Testing Guide
• End-to-End Testing
• Environment Validation
• Troubleshooting Guide

Reference Architecture

• Deployment Patterns
• Reference Configurations
• Platform Guides

Architecture and Design

• Architectural Decisions
  • Agent-based Installation Approach
  • Advanced Networking
  • Ansible Automation
  • Disconnected Support
  • Asset Management
  • Testing Framework
  • Infrastructure Testing
  • BMC Management
  • Testing Infrastructure
  • Manifest Generation
  • Identity Integration
  • Deployment Patterns
  • E2E Testing Framework

Deployment Types

Single-node OpenShift (SNO)

• One node acting as both master and worker
• Minimum Requirements:
  • 8 vCPUs
  • 16 GB RAM
  • 120 GB Storage
• SNO Configuration Guide
• SNO Examples

Three-node Compact Cluster

• Three master nodes that are also worker nodes
• Minimum Requirements per Node:
  • 8 vCPUs
  • 16 GB RAM
  • 120 GB Storage
• Compact Cluster Guide
• Example Configurations

Standard HA Cluster

• Three master nodes
• Two or more worker nodes
• Minimum Requirements per Node:
  • 8 vCPUs
  • 16 GB RAM
  • 120 GB Storage
• HA Cluster Guide
• Example Configurations

Platform Support

Bare Metal

• Bare Metal Guide
• Example Configurations
• BMC Management Guide

VMware

• VMware Guide
• Example Configurations
• Disconnected VMware Guide

Network Configuration

• Basic Networking
• Advanced Networking
  • Bond Configuration
  • VLAN Setup
  • SR-IOV Support
• Example Configurations

Testing and Validation

• Testing Framework Overview
• End-to-End Testing
• Environment Validation
• Troubleshooting Guide

Example Configurations

Browse our example configurations for common deployment scenarios in the examples/ directory:

• Bare Metal Examples
• VMware Examples
• SNO Examples
• Network Bonding Examples
• Stretched Cluster Examples

Utility Scripts

• get-rhcos-iso.sh: Download RHCOS ISO images
• download-openshift-cli.sh: Download OpenShift CLI tools
• Additional scripts in scripts/ and hack/ directories

Testing

• End-to-end tests in e2e-tests/
• Execution environment setup in execution-environment/
• Example configurations in examples/

Disconnected Installation

For disconnected installation guidance, refer to disconnected-info.md in the repository root.

For more detailed information, visit the official OpenShift documentation.

Authors

This project is maintained by:

• Ken Moini: https://github.com/kenmoini
• Tosin Akinosho: https://github.com/tosin2013

---

Note: This documentation is regularly updated to reflect the latest features and improvements in OpenShift Agent Install.