Skip to content

QUICKSTART.md

Latest commit

 

History

History
103 lines (74 loc) · 3.97 KB

QUICKSTART.md

File metadata and controls

103 lines (74 loc) · 3.97 KB
Raw

HotsTac(k)os Quick Start Guide

Guide for using HotsTac(k)os with HotStack scenarios.

Prerequisites

HotsTac(k)os must be installed and running. See INSTALL.md for installation instructions.

Setup for HotStack

1. Install OpenStack Client (Optional)

Install the OpenStack client packages on your host:

sudo make install-client

This installs:

  • python3-openstackclient - Main OpenStack CLI
  • python3-heatclient - Heat orchestration CLI

Note: You can also install these in a Python virtualenv if you prefer not to install system-wide.

2. Create HotStack Resources

make post-setup

This creates resources needed by HotStack scenarios:

  • HotStack project and user (hotstack/hotstack)
  • Quotas for hotstack project (40 cores, 100GB RAM, 1TB storage)
  • Compute flavors (hotstack.small, medium, large, etc.) - shared/public
  • Default private network (192.168.100.0/24) - shared
  • Provider network (172.31.0.128/25) - shared, for floating IPs
  • Router connecting private and external networks
  • Security group rules (SSH, ICMP) for both admin and hotstack projects
  • Test images (Cirros, CentOS Stream 9) - public
  • HotStack images (controller, blank, uefi-netboot, nat64, iPXE BIOS/EFI) - downloaded from GitHub releases and uploaded
  • Application credential (hotstack-cred) for the hotstack project
  • cloud-secret.yaml and hotstack-os-overrides.yaml in HOTSTACK_ENV_DIR (default: $HOME)
  • os_cloud: hotstack-os and dns_servers in hotstack-os-overrides.yaml
  • Optional merge of hotstack-os / hotstack-os-admin into ~/.config/openstack/clouds.yaml (existing cloud keys are not replaced)

If cloud-secret.yaml or hotstack-os-overrides.yaml already exists, make post-setup asks before overwriting. Confirming overwrite creates a backup named <file>.backup-<YYYYMMDD_HHMMSS>. If clouds.yaml is missing those cloud entries, you are prompted to add them; a backup is created before the file is edited.

Override the destination directory:

make post-setup HOTSTACK_ENV_DIR=/path

Note: Images are downloaded from the latest GitHub releases. If an image is not found, you may need to run the GitHub workflow to build and publish it first.

3. Verify Setup

# Use the hotstack user credentials
export OS_CLOUD=hotstack-os

# Verify resources are available
openstack network list
openstack flavor list
openstack image list

# Verify cloud-secret.yaml and hotstack-os-overrides.yaml were created
ls -l ~/cloud-secret.yaml ~/hotstack-os-overrides.yaml

4. Install Ansible and Collections

cd ../../  # Back to hotstack root

# Install Ansible (if not already installed)
sudo dnf install ansible-core
# Or: pip install ansible

# Install required Ansible collections
ansible-galaxy collection install -r requirements.yml

5. Run HotStack Scenario

# Run any HotStack scenario
ansible-playbook bootstrap.yml \
  -e @scenarios/sno-2-bm/bootstrap_vars.yml \
  -e @$HOME/hotstack-os-overrides.yaml \
  -e @$HOME/cloud-secret.yaml

Note: make post-setup writes cloud-secret.yaml and hotstack-os-overrides.yaml to HOTSTACK_ENV_DIR (default $HOME). The overrides file sets os_cloud: hotstack-os and dns_servers. If a file already exists you are prompted before overwrite; a .backup-<timestamp> copy is created if you confirm. It can also merge hotstack-os / hotstack-os-admin into ~/.config/openstack/clouds.yaml without replacing existing cloud entries. To recreate the extra-vars files, re-run make post-setup and answer y, or see the main README for manual credential creation.

Additional Resources