Skip to content

getting-started.md

Latest commit

 

History

History
executable file
·
175 lines (122 loc) · 4.79 KB

getting-started.md

File metadata and controls

executable file
·
175 lines (122 loc) · 4.79 KB
title Getting Started
parent Tutorials
nav_order 1

Getting Started

This tutorial walks you from zero to a running Qubinode Navigator deployment with Airflow, AI Assistant, and VM provisioning capabilities.

Estimated time: 15-25 minutes

Prerequisites

Before you begin, ensure you have:

  • OS: RHEL 9/10, CentOS Stream 10, Rocky Linux 9+, or Fedora 39+
  • RAM: 8GB minimum (16GB+ recommended)
  • Disk: 50GB+ free space
  • CPU: Virtualization enabled (VT-x/AMD-V)
  • Software: Git, Podman (or Docker)
  • Network: Internet access for container images

Step 1: Clone the Repository

# Install git if not present
sudo dnf install -y git

# Clone the repository
git clone https://github.com/Qubinode/qubinode_navigator.git
cd qubinode_navigator

Step 2: Configure Environment

Copy the environment template and customize it for your deployment:

cp .env.example .env

Edit .env to set at minimum:

  • QUBINODE_DOMAIN - Your domain name (e.g., lab.example.com)
  • QUBINODE_ADMIN_USER - Admin username
  • QUBINODE_CLUSTER_NAME - Cluster identifier

For AI Assistant features, configure a model provider (e.g., Gemini, Anthropic, or local Ollama). See the comments in .env.example for all available options.

Note: The deploy scripts will use sensible defaults if .env is not present, but configuring it ensures your domain, credentials, and AI model are set correctly.

Step 3: Run Pre-Flight Checks

The preflight script validates your system and auto-fixes common issues:

./scripts/preflight-check.sh --fix

What it checks:

  • CPU virtualization support
  • Container runtime (podman)
  • Network connectivity
  • Disk space and memory
  • Required external repositories

If all checks pass, you'll see:

Pre-flight checks passed!
You can proceed with deployment.

Step 4: Deploy the Full Stack

Deploy with Airflow orchestration, AI Assistant, and all supporting services:

# Full stack (recommended for most users)
./deploy-qubinode-with-airflow.sh

# OR: Development version (for contributors)
# sudo -E ./scripts/development/deploy-qubinode.sh

This deploys:

  • Apache Airflow (workflow orchestration) on port 8888
  • AI Assistant (PydanticAI orchestrator + RAG) on port 8080
  • MCP Server (tool API for LLM integration) on port 8889
  • PostgreSQL (metadata + pgvector) on port 5432

Step 5: Verify the Deployment

Check that all services are running:

# Check container status
sudo podman ps

# Verify Airflow
curl http://localhost:8888/health

# Verify AI Assistant
curl http://localhost:8080/orchestrator/status

Step 6: Access the Services

Service URL Purpose
Airflow UI http://YOUR_IP:8888 DAG management and monitoring
AI Assistant http://YOUR_IP:8080 Chat-driven deployment orchestrator
MCP Server http://YOUR_IP:8889 Tool API for LLM integration

Step 7: Run Your First DAG

  1. Open the Airflow UI at http://YOUR_IP:8888
  2. You'll see pre-built DAGs:
DAG Purpose
infrastructure_health_check Monitor infrastructure components
example_kcli_vm_provisioning Create/manage VMs with kcli
freeipa_deployment Deploy FreeIPA identity management
stepca_deployment Deploy Step-CA certificate authority
  1. Enable a DAG: Click the toggle switch
  2. Trigger a DAG: Click the "play" button
  3. Monitor: Watch progress in Graph or Grid view

Start with infrastructure_health_check to verify everything is working.

Troubleshooting

Containers not starting

# Check logs for a specific service
cd airflow && podman-compose logs -f

# Restart all services
cd airflow && podman-compose restart

Pre-flight check failures

# Run with verbose output
./scripts/preflight-check.sh --fix 2>&1 | tee preflight.log

# Common fixes:
# - Enable virtualization in BIOS
# - Start libvirtd: systemctl start libvirtd
# - Install podman: dnf install -y podman podman-compose

VM operations failing

# Verify kcli is working on the host
sudo kcli list vm

# Check if libvirtd is running
systemctl status libvirtd

Next Steps