{"id":36706912,"url":"https://github.com/borball/sno-agent-based-installer","last_synced_at":"2026-01-12T11:43:35.427Z","repository":{"id":134904512,"uuid":"610427155","full_name":"borball/sno-agent-based-installer","owner":"borball","description":"Script to deploy SNO with OpenShift Agent Based Installer and apply Telco RAN profiles","archived":false,"fork":false,"pushed_at":"2025-11-15T01:14:22.000Z","size":844,"stargazers_count":2,"open_issues_count":0,"forks_count":9,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-15T02:32:51.449Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/borball.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-03-06T18:51:08.000Z","updated_at":"2025-11-15T01:14:25.000Z","dependencies_parsed_at":"2023-11-27T16:51:56.586Z","dependency_job_id":"ea60c626-654b-42a7-a8a3-6dc6c71a8061","html_url":"https://github.com/borball/sno-agent-based-installer","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/borball/sno-agent-based-installer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borball%2Fsno-agent-based-installer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borball%2Fsno-agent-based-installer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borball%2Fsno-agent-based-installer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borball%2Fsno-agent-based-installer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/borball","download_url":"https://codeload.github.com/borball/sno-agent-based-installer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borball%2Fsno-agent-based-installer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338972,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T10:58:46.209Z","status":"ssl_error","status_checked_at":"2026-01-12T10:58:42.742Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-12T11:43:34.733Z","updated_at":"2026-01-12T11:43:35.420Z","avatar_url":"https://github.com/borball.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SNO Agent-Based Installer\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/OpenShift-4.14--4.21-red?style=flat-square\u0026logo=redhat\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/Platform-Single%20Node%20OpenShift-orange?style=flat-square\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/Architecture-x86__64%20%7C%20ARM64-blue?style=flat-square\"\u003e\n\u003c/p\u003e\n\n## Overview\n\nThe SNO Agent-Based Installer is a comprehensive toolkit for deploying and managing Single Node OpenShift (SNO) clusters using the OpenShift Agent-Based Installer. This repository provides automated scripts for ISO generation, cluster deployment, and configuration management, specifically optimized for Telco RAN workloads.\n\n**Version 2.x** introduces a redesigned configuration system with deployment profiles to simplify configuration management and improve maintainability.\n\n\u003e **Note**: This repository requires OpenShift 4.14 or later (tested up to 4.21). For multi-node deployments, see the sister repository: [Multiple Nodes OpenShift](https://github.com/borball/mno-with-abi)\n\n## 🆕 What's New in Version 2.x\n\n### Major Configuration Redesign\n- **🎯 Deployment Profiles**: Simplified configuration with predefined profiles (`ran`, `hub`, `none`)\n- **📁 Operator Profiles**: Flexible day1/day2 configuration profiles for operators\n- **🔧 Enhanced Operator Management**: Improved operator version locking and catalog source management\n- **⚙️ Update Control**: New mechanisms to control operator updates and upgrades\n\n### Latest Updates (November 2025)\n- **🚀 OpenShift 4.21 Support**: New RAN profile template for OpenShift 4.21\n- **🔧 ARM64/AArch64 Architecture**: Full support for ARM64-based deployments with dedicated performance profiles\n- **⚡ Power Saving Mode**: New tuned profile for power-efficient configurations\n- **✅ Enhanced Day2 Validation**: Improved operator readiness checks in `sno-ready.sh`\n- **📊 4.20 RAN RDS Enhancements**: Updated kdump, performance profiles, and tuned settings for 4.20\n\n### New Operators Support\n- **🌐 MetalLB Operator**: Load balancer support for bare metal environments\n- **🔗 NMState Operator**: Declarative network configuration management\n- **💻 OpenShift Virtualization**: KubeVirt hyperconverged platform support\n- **🔍 Node Feature Discovery**: Hardware feature detection and labeling\n- **🎮 NVIDIA GPU Operator**: GPU workload support\n- **📊 AMQ Streams \u0026 Console**: Apache Kafka messaging platform\n- **🏢 Multicluster Global Hub**: Enhanced multi-cluster management\n- **🔧 Multicluster Engine (MCE)**: Multi-cluster infrastructure management\n- **🛡️ OADP (ADP)**: OpenShift API for Data Protection and backup\n- **⚡ Intel FEC Operator**: Forward Error Correction acceleration\n- **🔄 Lifecycle Agent (LCA)**: Image-based cluster lifecycle management\n\n### Enhanced Features\n- **📋 PreGA Catalog Sources**: Support for pre-GA operator testing\n- **🎛️ Hardware Tuning**: Advanced CPU frequency and hardware optimization\n- **🔄 Profile System**: Modular configuration system for operators\n- **📦 Container Storage**: Enhanced container storage partitioning options\n- **💚 Power Saving Mode**: Configurable power management for reduced energy consumption\n- **🏗️ Multi-Architecture**: Support for x86_64 and ARM64/AArch64 platforms\n\n## ✨ Features\n\n- **📦 Automated ISO Generation**: Generate bootable ISO images with pre-configured operators and tunings\n- **🚀 Automated Deployment**: Deploy SNO clusters via BMC/Redfish integration\n- **⚙️ Day-1 Operations**: Pre-configure operators and system tunings during installation\n- **🔧 Day-2 Operations**: Post-deployment configuration and operator management\n- **✅ Validation Framework**: Comprehensive cluster validation and health checks\n- **🏗️ Telco RAN Ready**: Optimized for vDU applications with performance tunings\n- **🌐 Multi-Platform Support**: Works with HPE, ZT Systems, Dell, and OpenShift Virtualization environments\n- **🏗️ Multi-Architecture Support**: Supports both x86_64 and ARM64/AArch64 architectures\n- **🔄 Version Management**: Support for operator version locking and OpenShift version substitution\n- **📋 Custom Manifests**: Support for extra manifests in both Day-1 and Day-2 operations\n\n## 🏗️ Architecture\n\nThe toolkit consists of main components:\n\n| Script | Purpose | Phase |\n|--------|---------|-------|\n| `sno-iso.sh` | Generate bootable ISO with operators and tunings | Pre-deployment |\n| `sno-install.sh` | Deploy SNO via BMC/Redfish integration | Deployment |\n| `sno-day2.sh` | Apply post-deployment configurations | Post-deployment |\n| `sno-ready.sh` | Validate cluster configuration and health | Validation |\n| `fetch-infra-env.sh` | Fetch infrastructure environment information | Utility |\n\n### Directory Structure\n\n```\nsno-agent-based-installer/\n├── sno-*.sh                    # Main deployment scripts\n├── config.yaml.sample         # Sample configuration file\n├── CHANGELOG.md               # Version history and changes\n├── operators/                 # Operator subscription templates\n│   ├── adp/                  # OADP (OpenShift API for Data Protection)\n│   ├── amq/                  # AMQ Streams (Apache Kafka)\n│   ├── amq-console/          # AMQ Streams Console\n│   ├── cluster-logging/      # OpenShift Logging\n│   ├── fec/                  # Intel FEC (Forward Error Correction)\n│   ├── gitops/               # Red Hat OpenShift GitOps\n│   ├── gpu/                  # NVIDIA GPU Operator\n│   ├── kubevirt-hyperconverged/ # OpenShift Virtualization\n│   ├── lca/                  # Lifecycle Agent\n│   ├── local-storage/        # Local Storage Operator\n│   ├── lvm/                  # LVM Storage\n│   ├── mce/                  # Multicluster Engine\n│   ├── mcgh/                 # Multicluster Global Hub\n│   ├── metallb/              # MetalLB Load Balancer\n│   ├── nfd/                  # Node Feature Discovery\n│   ├── nmstate/              # NMState Network Configuration\n│   ├── operators/            # Nested operators directory (alternative structure)\n│   ├── ptp/                  # Precision Time Protocol\n│   ├── rhacm/                # Red Hat Advanced Cluster Management\n│   ├── sriov/                # SR-IOV Network Operator\n│   └── talm/                 # Topology Aware Lifecycle Manager\n├── templates/                 # Configuration templates and profiles\n│   ├── cluster-profile-*.yaml # Deployment profile templates\n│   ├── day1/                 # Day-1 (installation-time) configurations\n│   │   ├── catalogsource/    # Custom catalog sources\n│   │   ├── cluster-tunings/  # Version-specific cluster tunings\n│   │   ├── icsp/             # Image Content Source Policies\n│   │   └── */                # Operator-specific day-1 configs\n│   └── day2/                 # Day-2 (post-installation) configurations\n│       ├── performance-profile/ # Performance tuning profiles\n│       ├── ptp/              # PTP configurations\n│       ├── sriov/            # SR-IOV configurations\n│       └── */                # Operator-specific day-2 configs\n├── samples/                   # Sample configuration files\n├── test/                      # Test scripts and configurations\n├── mirror/                    # Mirroring scripts for disconnected environments\n└── instances/                 # Generated cluster instances (created during deployment)\n```\n\n## 📋 Prerequisites\n\n### System Requirements\n- OpenShift 4.14 or later (tested up to 4.21)\n- Linux system with internet access (x86_64 or ARM64/AArch64)\n- BMC/Redfish access to target hardware\n- HTTP server for ISO hosting\n- Minimum 16GB RAM, 120GB disk space for SNO node\n\n### Required Tools\nInstall the following tools before running the scripts:\n\n```bash\n# Install nmstatectl\nsudo dnf install /usr/bin/nmstatectl -y\n\n# Install yq (YAML processor)\n# See: https://github.com/mikefarah/yq#install\nsudo wget -qO /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64\nsudo chmod +x /usr/local/bin/yq\n\n# Install jinja2 CLI\npip3 install jinja2-cli jinja2-cli[yaml]\n\n#oc shall be installed, if you have not:\nsudo curl -L -o openshift-client-linux.tar.gz https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/openshift-client-linux.tar.gz\nsudo tar -xzvf openshift-client-linux.tar.gz -C /usr/local/bin/\n```\n\n## 🚀 Quick Start\n\n### 1. Configuration\n\nCreate a configuration file based on the sample or use a pre-configured profile:\n\n```bash\n# Option 1: Start with sample configuration\ncp config.yaml.sample config-mysno.yaml\n\n# Option 2: Use a pre-configured profile template\ncp templates/cluster-profile-ran-4.20.yaml config-mysno.yaml\n```\n\n**Version 2.x Configuration** - Simplified with deployment profiles:\n\n```yaml\ncluster:\n  domain: example.com\n  name: mysno\n  profile: ran                    # Deployment profile: ran, hub, none(not specify)\n\nhost:\n  hostname: mysno.example.com\n  interface: ens1f0\n  mac: b4:96:91:b4:9d:f0\n  ipv4:\n    enabled: true\n    ip: 192.168.1.100\n    dns: \n      - 192.168.1.1\n    gateway: 192.168.1.1\n    prefix: 24\n    machine_network_cidr: 192.168.1.0/24\n  disk: /dev/disk/by-path/pci-0000:c2:00.0-nvme-1\n\nbmc:\n  address: 192.168.1.200\n  username: Administrator\n  password: password\n\niso:\n  address: http://192.168.1.10/iso/mysno.iso\n\npull_secret: ${HOME}/pull-secret.json\nssh_key: ${HOME}/.ssh/id_rsa.pub\n\ncluster_tunings:\n  excludes:\n    - crun\n    - sctp\n\nnode_tunings:\n  performance_profile:\n    spec:\n      net:\n        userLevelNetworking: true\n      cpu:\n        isolated: 2-31,34-63\n        reserved: 0-1,32-33\n      hardwareTuning:\n        isolatedCpuFreq: 2500000\n        reservedCpuFreq: 2500000\n        \noperators:\n  local-storage:\n    data:\n      disk_by_path: pci-0000:03:00.0-nvme-1\n```\n\n### 2. Generate ISO\n\n```bash\n./sno-iso.sh config-mysno.yaml\n```\n\n### 3. Deploy SNO\n\n```bash\n./sno-install.sh\n```\n\n### 4. Apply Day-2 Configuration\n\n```bash\n./sno-day2.sh\n```\n\n### 5. Validate Deployment\n\n```bash\n./sno-ready.sh\n```\n\n## 📖 Detailed Usage\n\n### ISO Generation\n\nGenerate a bootable ISO image with pre-configured operators and tunings:\n\n```bash\n# Basic usage\n./sno-iso.sh config-mysno.yaml\n\n# Specify OpenShift version\n./sno-iso.sh config-mysno.yaml 4.14.33\n\n# Use specific release channel\n./sno-iso.sh config-mysno.yaml stable-4.14\n```\n\n**Available Options:**\n- `config file`: Path to configuration file (optional, defaults to `config.yaml`)\n- `ocp version`: OpenShift version or channel (optional, defaults to `stable-4.18`)\n\n### Automated Deployment\n\nDeploy SNO using BMC/Redfish integration:\n\n```bash\n# Deploy latest generated cluster\n./sno-install.sh\n\n# Deploy specific cluster\n./sno-install.sh mysno\n```\n\n**Supported Platforms:**\n- HPE iLO\n- ZT Systems\n- Dell iDRAC\n- KVM with Sushy tools\n\n### Day-2 Operations\n\nApply post-deployment configurations:\n\n```bash\n# Apply to latest cluster\n./sno-day2.sh\n\n# Apply to specific cluster\n./sno-day2.sh mysno\n```\n\n### Cluster Validation\n\nValidate cluster configuration and health:\n\n```bash\n# Validate latest cluster\n./sno-ready.sh\n\n# Validate specific cluster\n./sno-ready.sh mysno\n```\n\n## ⚙️ Configuration Reference\n\n### Basic Configuration\n\n```yaml\ncluster:\n  domain: example.com          # Cluster domain\n  name: mysno                  # Cluster name\n  ntps:                        # NTP servers (optional)\n    - pool.ntp.org\n  profile: ran                 # Profile template\n\nhost:\n  hostname: mysno.example.com  # Node hostname\n  interface: ens1f0            # Primary network interface\n  mac: b4:96:91:b4:9d:f0      # MAC address\n  disk: /dev/nvme0n1          # Installation disk\n\n```\n\n### Network Configuration\n\n#### IPv4 Configuration\n```yaml\nhost:\n  ipv4:\n    enabled: true\n    dhcp: false\n    ip: 192.168.1.100\n    dns: \n      - 192.168.1.1\n    gateway: 192.168.1.1\n    prefix: 24\n    machine_network_cidr: 192.168.1.0/24\n```\n\n#### IPv6 Configuration\n```yaml\nhost:\n  ipv6:\n    enabled: true\n    dhcp: false\n    ip: 2001:db8::100\n    dns: \n      - 2001:db8::1\n    gateway: 2001:db8::1\n    prefix: 64\n    machine_network_cidr: 2001:db8::/64\n```\n\n#### VLAN Configuration\n```yaml\nhost:\n  vlan:\n    enabled: true\n    name: ens1f0.100\n    id: 100\n```\n\n### Configuration Structure\n\nThe SNO Agent-Based Installer uses a **hierarchical configuration system** with deployment profiles that provide pre-configured templates for different use cases. This system allows you to start with sensible defaults and override only what you need to customize.\n\n#### Configuration Hierarchy\n\n```\nconfig.yaml (your configuration)\n    ↓ inherits from\ncluster-profile-\u003cprofile-name\u003e-\u003cocp-version\u003e.yaml (template)\n    ↓ provides defaults for\nAll configuration sections\n```\n\n#### How Profile Inheritance Works\n\n1. **Profile Selection**: The `cluster.profile` field in your `config.yaml` determines which template to use\n2. **Template Loading**: The system loads `templates/cluster-profile-\u003cprofile\u003e-\u003cocp-version\u003e.yaml`\n3. **Override Mechanism**: Any values you define in `config.yaml` override the template defaults\n4. **Version Fallback**: If version-specific template doesn't exist, falls back to base profile\n\n#### Available Deployment Profiles\n\n| Profile | Template File | Use Case | Key Features |\n|---------|---------------|----------|--------------|\n| `ran` | `cluster-profile-ran-4.20.yaml` | Telco RAN workloads | Performance tuning, RAN operators, workload partitioning |\n| `hub` | `cluster-profile-hub.yaml` | Hub cluster management | RHACM, GitOps, TALM, cluster logging |\n| `none` | `cluster-profile-none.yaml` | Minimal setup | Basic cluster capabilities only |\n| Not specified | No template loaded | Custom configuration | Manual configuration of all settings |\n\n#### Configuration Examples\n\n**Example 1: Using RAN Profile with Minimal Overrides**\n\n```yaml\n# config-mysno.yaml\ncluster:\n  domain: example.com\n  name: mysno\n  profile: ran                    # Inherits from cluster-profile-ran-\u003cOCP-Y\u003e.yaml\n\nhost:\n  hostname: mysno.example.com\n  interface: ens1f0\n  mac: b4:96:91:b4:9d:f0\n  ipv4:\n    enabled: true\n    ip: 192.168.1.100\n    gateway: 192.168.1.1\n    prefix: 24\n    machine_network_cidr: 192.168.1.0/24\n  disk: /dev/disk/by-path/pci-0000:c2:00.0-nvme-1\n\noperators:\n  local-storage:\n    data:\n      disk_by_path: pci-0000:03:00.0-nvme-1\n\n# The RAN profile automatically provides:\n# - Performance tuning (workload partitioning, performance profile)\n# - RAN operators (PTP, SR-IOV, FEC, LCA, OADP)\n# - Cluster tunings for 4.20\n# - Update control settings\n```\n\n**Example 2: Overriding Operator Settings**\n\n```yaml\n# config-mysno.yaml  \ncluster:\n  profile: ran                    # Base RAN configuration\n\n# Override specific operators from the RAN profile\noperators:\n  ptp:\n    enabled: true                 # Keep PTP enabled (from profile)\n    data:\n      boundary_clock:\n        ha_enabled: true          # Override: enable HA boundary clock\n        profiles:\n          - name: custom-bc-profile\n            slave: ens2f0         # Override: use different interface\n            masters: [ens2f1, ens2f2]\n  \n  local-storage:\n    enabled: false                # Override: enable local storage\n  \n  lvm:\n    enabled: true                 # Override: enable LVM\n    data:                         # Override: Env specific settings\n      disks:\n        - path: /dev/disk/by-path/pci-0000:c4:00.0-nvme-1\n          wipe_table: true\n      device_classes:\n        - name: vg1\n          thin_pool_name: thin-pool-1\n          selector:\n            paths:\n              - /dev/disk/by-path/pci-0000:c4:00.0-nvme-1\n```\n\n**Example 3: Hub Profile with Custom GitOps Configuration**\n\n```yaml\n# config-hub.yaml\ncluster:\n  profile: hub                    # Inherits hub cluster settings\n\n# Override GitOps configuration\noperators:\n  gitops:\n    enabled: true                 # Keep GitOps enabled (from profile)\n    data:\n      repo:\n        clusters:\n          url: ssh://git@github.com/myorg/clusters.git\n          targetRevision: main\n          path: clusters\n        policies:\n          url: ssh://git@github.com/myorg/policies.git\n          targetRevision: main\n          path: policies\n```\n\n**Example 4: Custom Hardware Tuning Override**\n\n```yaml\n# config-mysno.yaml\ncluster:\n  profile: ran\n\n# Override performance tuning from RAN profile\nnode_tunings:\n  performance_profile:\n    enabled: true\n    spec:\n      cpu:\n        isolated: 4-47,52-95      # Override: different CPU layout\n        reserved: 0-3,48-51\n      hardwareTuning:\n        isolatedCpuFreq: 3000000  # Override: higher frequency\n        reservedCpuFreq: 3200000\n  tuned_profile:\n    profiles:\n      - profile: performance-patch\n      - profile: hpe-settings     # Override: HPE-specific tuning instead of Dell\n```\n\n**Example 5: Power Saving Mode Configuration**\n\n```yaml\n# config-mysno.yaml\ncluster:\n  profile: ran\n\n# Enable power saving mode for reduced energy consumption\nnode_tunings:\n  performance_profile:\n    enabled: true\n    workloadHints:\n      realTime: true\n      highPowerConsumption: false      # Enable power saving\n      perPodPowerManagement: false\n  tuned_profile:\n    enabled: true\n    power-saving:                      # Enable power saving tuned profile\n      enabled: true\n      cpufreq_max_perf_percent: 70    # Limit CPU to 70% max performance\n      cpufreq_governor: powersave      # Use powersave governor\n```\n\n**Example 6: ARM64/AArch64 Configuration**\n\n```yaml\n# config-mysno.yaml\ncluster:\n  profile: ran\n  domain: example.com\n  name: mysno-arm\n\nhost:\n  hostname: mysno-arm.example.com\n  interface: eth0\n  mac: 00:11:22:33:44:55\n  disk: /dev/nvme0n1\n\nnode_tunings:\n  performance_profile:\n    enabled: true\n    kernelPageSize: 64k           # ARM64-specific page size\n```\n\n#### Profile Template Structure\n\nEach profile template contains the following sections:\n\n```yaml\n# cluster-profile-ran-4.20.yaml (example)\ncluster:\n  capabilities:                   # Cluster capability settings\n    baselineCapabilitySet: None\n    additionalEnabledCapabilities: [...]\n\ncluster_tunings: 4.20            # Version-specific cluster tunings\n\nnode_tunings:                    # Performance and tuning settings\n  workload_partitioning: {...}\n  performance_profile: {...}\n  tuned_profile: {...}\n\nupdate_control:                  # Operator update control\n  pause_before_update: true\n  disable_operator_auto_upgrade: true\n\noperators:                       # Pre-configured operators\n  ptp: {...}\n  sriov: {...}\n  lvm: {...}\n  # ... other operators\n\n# Additional sections like proxy, readiness, etc.\n```\n\n#### Best Practices\n\n1. **Start with a Profile**: Choose the profile that best matches your use case\n2. **Override Selectively**: Only override the specific settings you need to change\n3. **Use Version-Specific Profiles**: Use the profile that matches your OpenShift version\n4. **Test Overrides**: Validate that your overrides work as expected\n5. **Document Changes**: Comment your overrides to explain why they differ from the profile \n\n## 🔧 Advanced Features\n\n### Custom Manifests\n\nInclude custom resources during installation and post-deployment:\n\n```yaml\nextra_manifests:\n  day1:\n    - ${HOME}/day1-manifests\n    - ./install-time-configs\n    - ${OCP_Y_VERSION}/version-specific    # Auto-substituted with Y version (e.g., 4.16)\n  day2:\n    - ${HOME}/day2-manifests\n    - ./post-install-configs\n    - ${OCP_Z_VERSION}/patch-specific     # Auto-substituted with Z version (e.g., 4.16.3)\n```\n\n**Version Substitution Variables:**\n- `${OCP_Y_VERSION}`: Substituted with major.minor version (e.g., `4.16`)\n- `${OCP_Z_VERSION}`: Substituted with full version (e.g., `4.16.3`)\n- `${OCP_Y_RELEASE}`: Substituted with Y release info\n- `${OCP_Z_RELEASE}`: Substituted with Z release info\n\n### Operator-Specific Manifests and Profiles\n\n**Version 2.x** introduces operator profiles for flexible configuration:\n\n```yaml\noperators:\n  example:\n    enabled: false\n    version: example.v4.20.0-202507211933\n    source: prega              # Catalog source\n    data:                      # Variables passed to templates\n      key1: value1\n      key2: value2\n    \n    # Day-1 configurations with profiles\n    day1:\n      - profile: a             # Uses templates/day1/example/a/\n      - profile: b             # Uses templates/day1/example/b/\n    \n    # Day-2 configurations with profiles  \n    day2:\n      - profile: a             # Uses templates/day2/example/a/\n      - profile: b             # Uses templates/day2/example/b/\n\n  local-storage:\n    enabled: false\n    source: prega\n    data:\n      local_volume:\n        name: local-disks\n        storageClassName: general\n      disk_by_path: pci-0000:03:00.0-nvme-1\n      partitions:\n        10g: 30\n\n  lvm:\n    enabled: true\n    source: prega\n    data:\n      disks:\n        - path: /dev/disk/by-path/pci-0000:03:00.0-nvme-1\n          wipe_table: true\n      device_classes:\n        - name: vg1\n          thin_pool_name: thin-pool-1\n    day1:\n      - profile: wipe-disks    # Disk preparation profile\n```\n\n**Profile System:**\n- If no profiles specified: uses `default/` directory\n- Profiles allow multiple configurations per operator\n- Supports `.sh`, `.yaml`, and `.yaml.j2` files\n- Shell scripts execute before other files\n\n### Profile Templates\n\nThe repository includes several pre-configured profile templates:\n\n| Template | Purpose | Key Features |\n|----------|---------|--------------|\n| `cluster-profile-full.yaml` | Complete configuration template | All sections with examples |\n| `cluster-profile-ran-4.18.yaml` | RAN-optimized for 4.18+ | Performance tuning, RAN operators |\n| `cluster-profile-hub.yaml` | Hub cluster configuration | RHACM, GitOps, TALM enabled |\n| `cluster-profile-none.yaml` | Minimal configuration | Basic cluster setup only |\n\n### Version-Specific Templates\n\nRAN profiles are available for different OpenShift versions with version 2.x enhancements:\n- `cluster-profile-ran-4.14.yaml` - OpenShift 4.14 optimizations\n- `cluster-profile-ran-4.15.yaml` - OpenShift 4.15 optimizations  \n- `cluster-profile-ran-4.16.yaml` - OpenShift 4.16 optimizations\n- `cluster-profile-ran-4.17.yaml` - OpenShift 4.17 optimizations\n- `cluster-profile-ran-4.18.yaml` - OpenShift 4.18 optimizations\n- `cluster-profile-ran-4.19.yaml` - OpenShift 4.19 optimizations\n- `cluster-profile-ran-4.20.yaml` - OpenShift 4.20 optimizations with new features\n- `cluster-profile-ran-4.21.yaml` - **Latest** OpenShift 4.21 optimizations\n\n**New in 4.20/4.21 Profiles:**\n- Enhanced operator profile system\n- Update control mechanisms\n- PreGA catalog source support\n- Improved hardware tuning options\n- ARM64/AArch64 architecture support\n- Power saving mode configurations\n- Enhanced day2 operator validation\n\n## 🧪 Testing\n\nThe repository includes comprehensive test configurations:\n\n```bash\n# Run basic test\n./test/test.sh\n\n# Hub cluster test\n./test/test-acm0.sh                     # RHACM hub test\n                  # Virtual machine deployment\n```\n\n## 📁 Sample Configurations\n\nThe repository includes various sample configurations for different scenarios:\n\n| Configuration | Description | Use Case |\n|---------------|-------------|----------|\n| `config-full.yaml` | Complete configuration with all options | Production deployments |\n| `config-ipv4.yaml` | Basic IPv4 networking | Standard deployments |\n| `config-ipv6.yaml` | IPv6 networking | IPv6-only environments |\n| `config-dual-stack.yaml` | IPv4 + IPv6 dual-stack | Dual-stack networking |\n| `config-ipv6-proxy.yaml` | IPv6 with proxy support | Proxy environments |\n| `config-ipv6-vlan.yaml` | IPv6 with VLAN tagging | VLAN networks |\n| `config-bond.yaml` | Network bonding configuration | High availability networking |\n| `config-ran.yaml` | RAN-optimized configuration | Telco RAN deployments |\n\n### Usage\n```bash\n# Use a sample configuration\ncp samples/config-ipv4.yaml config-mysno.yaml\n./sno-iso.sh config-mysno.yaml\n```\n\n## 📊 Validation Checklist\n\nThe `sno-ready.sh` script provides comprehensive validation:\n\n### Core Validation\n- ✅ **Cluster Health**: Node status, operator health, pod status\n- ✅ **Machine Configs**: CPU partitioning, kdump, performance settings\n- ✅ **Performance Profile**: Isolated/reserved CPUs, real-time kernel\n- ✅ **Network**: SR-IOV node state, network diagnostics\n- ✅ **System**: Kernel parameters, cgroup configuration, container runtime\n\n### Operator Validation\n- ✅ **Day1 Operators**: PTP, SR-IOV, Local Storage, LVM, Cluster Logging\n- ✅ **Day2 Operator Readiness**: Comprehensive checks for all configured operators\n  - MetalLB load balancer status\n  - NMState network configuration\n  - LCA (Lifecycle Agent) readiness\n  - OADP (OpenShift API for Data Protection) backup capability\n  - Intel FEC operator acceleration\n  - GPU operator functionality\n  - OpenShift Virtualization (KubeVirt) hyperconverged status\n- ✅ **Hub Cluster Features**: RHACM, GitOps, TALM, MCE, MCGH\n\n### Advanced Validation\n- ✅ **Monitoring**: AlertManager, Prometheus, Telemetry settings\n- ✅ **Storage**: Local storage, LVM storage configurations and readiness\n- ✅ **Update Control**: Operator upgrade policies and pause mechanisms\n- ✅ **Architecture Support**: Validation for both x86_64 and ARM64 platforms\n\n### Version 2.x Enhancements (November 2025)\n- 🔄 **Profile Validation**: Deployment profile-specific checks\n- 📋 **Operator Profiles**: Validation of day1/day2 profile configurations\n- 🎯 **Catalog Sources**: PreGA and custom catalog source validation\n- ⚙️ **Day2 Readiness**: Enhanced operator day2 configuration validation\n- 💚 **Power Management**: Validation of power saving tuned profiles\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborball%2Fsno-agent-based-installer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fborball%2Fsno-agent-based-installer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborball%2Fsno-agent-based-installer/lists"}