AAP Demo Quick Start

Deploy AAP to a local MicroShift cluster in minutes.

SECURITY NOTICE — DEVELOPMENT ENVIRONMENT ONLY

aap-demo is a LOCAL DEVELOPMENT tool and must NEVER be used in production.

Prerequisites

• CRC (OpenShift Local) — Download
• 16 GB RAM minimum — default VM allocation is 16 GB (override with CRC_MEMORY=24576 aap-demo create for 24 GB). On Linux, aap-demo create prompts for optional temp swap on memory-constrained hosts (see scripts/README.md)
• Pull secret — download from the Red Hat console, then run:

mkdir -p ~/.aap-demo
cp ~/Downloads/pull-secret.txt ~/.aap-demo/pull-secret.txt

Install

git clone https://github.com/RedHatOfficial/aap-demo.git && cd aap-demo && ./install.sh && aap-demo deploy

aap-demo create provisions the MicroShift VM only. aap-demo deploy installs OLM and AAP (use deploy for the typical path; create alone is for cluster-only setup).

Cluster credentials live at ~/.aap-demo/kubeconfig.microshift and are not merged into ~/.kube/config. If you relied on the old default kubeconfig behavior, run:

export KUBECONFIG=~/.aap-demo/kubeconfig.microshift
# or: aap-demo kubeconfig   # refresh file and print export command

Status

aap-demo version       # Tool version, commit, and build timestamp
aap-demo status        # Show routes and credentials

AAP Demo Status
===============

Infra:       OpenShift Local (CRC)
Cluster:     running (crc-microshift)

Namespaces:
-----------
  aap-operator         27/29 pods   aap

AAP Deployments:
----------------
  https://aap-aap-operator.apps.127.0.0.1.nip.io

Credentials:
------------
  aap-operator: admin / <password>

Addons:
-------
  mcp-server      disabled
  portal          disabled
  setup-pah       disabled
  ao            disabled
  apme-eap        disabled
  local-cache     disabled
  product-demos       disabled
  product-demo-satellite  disabled

Addons to add additional functionality

aap-demo enable              # List all addons
aap-demo enable portal       # Installs Automation Portal
aap-demo enable setup-pah     # Configures Private Automation Hub Credentials
aap-demo enable mcp-server   # MCP server for AI assistants
aap-demo enable ao           # Automation Orchestrator (GA; no aapctl required — see addons/ao/README.md)
aap-demo enable apme-eap     # Early Access Program only for APME
aap-demo enable local-cache  # Caches AAP containers locally so you don't re-download after destroy/create

# Ansible Product Demos - Official demo content from ansible/product-demos
aap-demo enable product-demos        # Five domains at once (includes base; Satellite opt-in)
aap-demo enable product-demo-satellite  # Satellite demos (requires a Satellite server)
aap-demo disable addon_name  # Disables addon

After aap-demo destroy, reload cached images with:

aap-demo enable local-cache load   # one-shot reload into fresh VM
aap-demo enable local-cache        # restore auto-load on future deploys

Daily Use

aap-demo start         # Start the cluster (after stop or reboot)
aap-demo stop          # Stop gracefully
aap-demo idle true     # Scale down AAP to save resources
aap-demo idle false    # Scale back up
aap-demo ssh           # SSH into the cluster node
aap-demo status        # Check everything
aap-demo repair        # Fix after sleep/wake issues

Troubleshooting

aap-demo diagnose      # Quick health check — finds common issues
aap-demo diagnose --ai # AI-powered analysis (requires claude CLI)
aap-demo must-gather   # Collect full diagnostics for support

On MicroShift 4.22+, aap-demo deploy relaxes container signature verification for registry.redhat.io inside the CRC VM so operator index images can pull. This is a demo-only workaround and must not be used as a production pattern.

Clean Up

aap-demo clean         # Remove AAP (keep cluster)
aap-demo destroy       # Delete everything
./install.sh --uninstall  # Remove aap-demo CLI

Documentation

• Full README — Complete documentation, architecture, troubleshooting
• Architecture Decision Records — Design decisions and rationale
• Contributing — Development guidelines
• Linting — Ansible linting setup

Versioning

Every PR to main that changes files (other than VERSION itself) must bump the semver in VERSION. CI enforces this via .github/workflows/version-check.yaml.

aap-demo version              # show current version + git build info
cz bump --increment PATCH     # after ./scripts/setup-linting.sh (optional)