hyperconverged-lab.sh

#!/usr/bin/env bash
# shellcheck disable=SC2124,SC2145,SC2294,SC2086,SC2087,SC2155
#
# Hyperconverged Lab Deployment Selector
#
# This script provides a simple interface to deploy Genestack (OpenStack on Kubernetes)
# in a hyperconverged configuration using either:
#
#   1. Kubespray   - Traditional approach using Ubuntu VMs and Kubespray/Ansible
#   2. Talos Linux - Modern approach using Talos Linux immutable OS
#
# Usage:
#   ./hyperconverged-lab.sh                    # Interactive mode - prompts for platform
#   ./hyperconverged-lab.sh kubespray [args]   # Deploy using Kubespray
#   ./hyperconverged-lab.sh talos [args]       # Deploy using Talos Linux
#
# For uninstall, use the corresponding uninstall scripts:
#   ./hyperconverged-lab-kubespray-uninstall.sh
#   ./hyperconverged-lab-talos-uninstall.sh
#

set -o pipefail
set -e

SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)

function show_usage() {
    cat <<EOF
Hyperconverged Lab Deployment Script

This script deploys Genestack (OpenStack on Kubernetes) in a hyperconverged
configuration on OpenStack infrastructure.

USAGE:
    $(basename "$0") [PLATFORM] [OPTIONS]

PLATFORMS:
    kubespray    Deploy using Kubespray on Ubuntu (traditional approach)
                 - Uses Ubuntu VMs with SSH access
                 - Kubernetes deployed via Kubespray/Ansible
                 - Requires SSH keypair for node access

    talos        Deploy using Talos Linux (modern approach)
                 - Uses Talos Linux immutable OS
                 - Kubernetes deployed via talosctl
                 - No SSH - managed via Talos API
                 - Includes Talos-specific configs for Longhorn, Kube-OVN, Ceph

    help         Show this help message

OPTIONS:
    -i <list>    Comma-separated list of OpenStack services to include.
                 Component names install their control-plane chart. Data-plane
                 pseudo services install the named data-plane component AND
                 imply their control plane:
                   cinder-volume  full cinder stack: single late chart install
                                  + volume/VG prep, cinder volumes playbook,
                                  volume type/QoS
                   manila-share   full manila stack: chart + enablement
                                  (secrets, service image build, share type)
                 Add the plain component name only when you want the chart
                 without the data plane.
    -e <list>    Comma-separated list of OpenStack services to exclude.
                 Excluded components also skip their component-specific
                 extras steps run by -x (e.g. -x -e octavia runs the extras
                 but skips the Octavia preconf/install; -e k9s skips k9s,
                 -e cinder-volume skips the cinder data-plane enablement).
    -x           Run extra operations (k9s install, Octavia preconf, etc.)
    --envoy-gateway-config
                 Deploy Envoy using the internal/external gateway config file
                 instead of the legacy flex-gateway.
    --envoy-gateway-acme
                 Deploy Envoy config mode with Let's Encrypt HTTP01 issuer
                 config and per-service external HTTPS listeners.
    --no-envoy-gateway-acme
                 Disable Let's Encrypt config generation for Envoy config mode.
    --internal-metallb-ip <ip>
                 Use a fixed IP for the internal Envoy MetalLB pool. If unset
                 with --envoy-gateway-config, the lab creates a second VIP port.

ENVIRONMENT VARIABLES:
    ACME_EMAIL          Email for ACME/Let's Encrypt certificates
    GATEWAY_DOMAIN      Domain name for the gateway (default: cluster.local)
    OS_CLOUD            OpenStack cloud configuration name (default: default)
    OS_FLAVOR           Flavor to use for instances
    OS_IMAGE            Image to use (platform-specific defaults apply)
    LAB_NAME_PREFIX     Prefix for all created resources
    LAB_NETWORK_MTU     MTU for lab networks (default: 1500)
    HYPERCONVERGED_DEV  If set to "true", enables development mode which transports
                        the local environment checkout into the hyperconverged lab
                        for easier testing and debugging.
    HYPERCONVERGED_CINDER_VOLUME
                        If set to "true", enables iSCSI cinder volume support.
                        Equivalent to including the 'cinder-volume' pseudo
                        service via -i; '-e cinder-volume' overrides both.
    CINDER_STORAGE_INTERFACE
                        Ansible fact name of the storage network interface
                        used by the cinder volumes playbook
                        (default: ansible_enp3s0).
    CINDER_STORAGE_INTERFACE_SECONDARY
                        Secondary storage interface fact name (defaults to
                        CINDER_STORAGE_INTERFACE).
    CINDER_BACKEND_NAME Cinder backend name for the volumes playbook
                        (default: lvmdriver-1).
    CINDER_WORKER_NAME  Cinder worker type for the volumes playbook
                        (default: lvm). The cinder release branch is no longer
                        configurable here: it is derived from the cinder chart
                        version in helm-chart-versions.yaml so the data plane
                        always matches the control plane.
    HYPERCONVERGED_MANILA_SHARE
                        If set to "true", runs the full Manila enablement
                        (secrets, service image build, share type) with a
                        single manila chart install performed by the
                        enablement step. Equivalent to including the
                        'manila-share' pseudo service via -i; '-e manila-share'
                        overrides both. Default "false" installs no manila.
    HYPERCONVERGED_ENVOY_GATEWAY_CONFIG
                        If set to "true", deploys Envoy using the internal/external
                        gateway config file path instead of the legacy flex-gateway.
    HYPERCONVERGED_ENVOY_GATEWAY_ACME
                        If set to "true", enables Let's Encrypt issuer config for
                        the external Envoy gateway config-mode lab path.
    HYPERCONVERGED_INTERNAL_METALLB_IP
                        Optional fixed IP for the internal Envoy MetalLB pool. If
                        unset, the lab creates a second internal VIP port.
    DISABLE_OPENSTACK
                        if set to "true", no openstack services will be deployed.

EXAMPLES:
    # Interactive mode - will prompt for platform choice
    $(basename "$0")

    # Deploy using Kubespray
    $(basename "$0") kubespray

    # Deploy using Talos Linux
    $(basename "$0") talos

    # Deploy Kubespray with extra services and extras enabled
    $(basename "$0") kubespray -i heat,octavia -x

    # Deploy Kubespray with internal/external Envoy gateways
    $(basename "$0") kubespray --envoy-gateway-config

    # Deploy Talos with specific services excluded
    $(basename "$0") talos -e skyline

UNINSTALL:
    Use the platform-specific uninstall scripts:

    # Uninstall Kubespray deployment
    ./hyperconverged-lab-kubespray-uninstall.sh

    # Uninstall Talos deployment
    ./hyperconverged-lab-talos-uninstall.sh

For more information, see the Genestack documentation.
EOF
}

function prompt_for_platform() {
    echo ""
    echo "Hyperconverged Lab Deployment"
    echo "============================="
    echo ""
    echo "Select your deployment platform:"
    echo ""
    echo "  1) Kubespray"
    echo "     - Traditional approach using Ubuntu VMs"
    echo "     - Kubernetes deployed via Kubespray/Ansible"
    echo "     - SSH-based node management"
    echo ""
    echo "  2) Talos Linux"
    echo "     - Modern immutable Linux OS designed for Kubernetes"
    echo "     - API-based management (no SSH)"
    echo "     - Includes Talos-specific configurations for Longhorn, Kube-OVN, Ceph"
    echo ""

    read -rp "Enter your choice [1/2]: " choice

    case "$choice" in
        1|kubespray|Kubespray|KUBESPRAY)
            echo ""
            echo "Selected: Kubespray"
            PLATFORM="kubespray"
            ;;
        2|talos|Talos|TALOS)
            echo ""
            echo "Selected: Talos Linux"
            PLATFORM="talos"
            ;;
        *)
            echo "Invalid choice. Please enter 1 or 2."
            exit 1
            ;;
    esac
}

# Check for help flag first
if [[ "$1" == "help" || "$1" == "--help" || "$1" == "-h" ]]; then
    show_usage
    exit 0
fi

# Determine platform from first argument or prompt
if [[ -n "$1" && "$1" != -* ]]; then
    case "$1" in
        kubespray|Kubespray|KUBESPRAY)
            PLATFORM="kubespray"
            shift
            ;;
        talos|Talos|TALOS)
            PLATFORM="talos"
            shift
            ;;
        *)
            echo "Unknown platform: $1"
            echo ""
            show_usage
            exit 1
            ;;
    esac
else
    prompt_for_platform
fi

# Execute the appropriate platform-specific script
case "$PLATFORM" in
    kubespray)
        echo ""
        echo "Launching Kubespray deployment..."
        echo ""
        exec "${SCRIPT_DIR}/hyperconverged-lab-kubespray.sh" "$@"
        ;;
    talos)
        echo ""
        echo "Launching Talos Linux deployment..."
        echo ""
        exec "${SCRIPT_DIR}/hyperconverged-lab-talos.sh" "$@"
        ;;
esac