bstrauss84/openshift-airgap-architect

Description: OpenShift Airgap Architect; a local-first wizard that generates and validates doc-accurate OpenShift install and mirroring configs for disconnected and Gov...

View on GitHub ↗Jump to charts ↓

Summary Information

Updated 11 minutes ago
Added to GitGenius on July 9th, 2026
Created on February 25th, 2026
Open Issues & Pull Requests: 5 (+0)
Number of forks: 10
Total Stargazers: 27 (+0)
Total Subscribers: 3 (+0)

Issue Activity (beta)

Open issues: 3
New in 7 days: 0
Closed in 7 days: 0
Avg open age: 26 days
Stale 30+ days: 3
Stale 90+ days: 0

Recent activity

Opened in 7 days: 0
Closed in 7 days: 0
Comments in 7 days: 0
Events in 7 days: 0

Top labels

No label distribution available yet.

Most active issues this week

No issue events were indexed in the last 7 days.

Detailed Description

OpenShift Airgap Architect is a local-first wizard application designed to generate and validate OpenShift installation and mirroring configurations for disconnected and government-restricted network environments. Written primarily in JavaScript, the tool runs entirely on a user's machine using Docker or Podman, with no data transmitted to external services unless explicitly triggered for operator discovery or release-channel updates. The application addresses a specific operational gap: platform engineers and SREs planning disconnected OpenShift installations need a single, repeatable place to configure cluster identity, networking, mirroring, trust bundles, and platform-specific settings before running the installer or oc-mirror tooling.

The wizard guides users through scenario-based configuration for multiple installation methods including Bare Metal Agent-Based, Bare Metal IPI/UPI, VMware vSphere IPI/UPI, AWS GovCloud IPI/UPI, Azure Government IPI, Nutanix IPI, and IBM Cloud IPI. For each scenario, the application generates install-config.yaml, agent-config.yaml for agent-based deployments, imageset-config.yaml in oc-mirror v2 format, and a FIELD_MANUAL.md document. The field manual is particularly distinctive: it provides compartmentalized, scenario-specific guidance with numbered actionable sections drawn from OpenShift 4.17–4.20 documentation, tailored to the exact configuration including platform, connectivity, FIPS requirements, proxy settings, NTP configuration, mirroring details, operators, and specific values like cluster name, VIPs, and registry FQDN. Each section cites official Red Hat documentation sources. The application also generates NTP MachineConfigs when NTP servers are configured.

A core design principle is credentials safety. Pull secrets and platform-specific credentials like BMC or vCenter passwords are not persisted by default, with optional export only when explicitly included. Helper functions generate pull secrets and SSH keypairs locally without storing them. The application supports optional operator discovery through oc-mirror list operators, requiring registry.redhat.io authentication. It handles trust bundles and proxy settings with version-appropriate policies, such as Proxyonly or Always modes. An integrated oc-mirror tab allows users to run oc-mirror v2 directly from the application, supporting mirror-to-disk, disk-to-mirror, and mirror-to-mirror workflows with per-run credentials and comprehensive preflight validation.

The user interface includes several accessibility and usability features. A live YAML preview drawer on the right side shows real-time generated YAML as users configure settings, with syntax highlighting and the ability to download individual files. Credentials are obfuscated by default with a toggle to show sensitive values. The application supports dark mode toggling from the Tools menu. Modal dialogs implement consistent focus trap behavior with keyboard navigation support. An Operations section provides a background job viewer with live streaming output, job history, and downloadable timestamped logs for Cincinnati refresh operations, operator scans, and oc-mirror runs. Optional in-app feedback generates prefilled GitHub issue URLs with copyable markdown fallbacks, though this is hidden on high-side profiles.

The application supports IPv6-only single-stack networking, allowing users to configure OpenShift clusters with IPv6 exclusively or in dual-stack modes for bare metal and vSphere platforms across all installation methods. Export options let users choose whether to include credentials, certificates, client tools, and openshift-install binaries in run bundles. An advanced option bundles a complete high-side runtime package with container images and deployment scripts for fully disconnected systems.

Technically, the backend uses Node.js 20 with SQLite for state and job history, while the frontend uses React with Vite. Both container images are based on Red Hat UBI 9 and run non-root, with the backend running as UID 1001. The application can run via Docker Compose, Podman Compose, or directly on the host. Local development requires Node 20 or higher, with separate development servers for backend and frontend. The project includes test suites in both backend and frontend directories with contribution conventions documented in docs/CONTRIBUTING.md.

openshift-airgap-architect
by
bstrauss84bstrauss84/openshift-airgap-architect

Repository Details

Fetching additional details & charts...