holodeck

Holodeck

A tool for creating and managing GPU-ready Cloud test environments.

📖 Documentation

• Quick Start
• Prerequisites
• Commands Reference
• Contributing Guide
• Examples
• Latest Release

✨ Features

• Multi-OS Support: Ubuntu, Rocky Linux 9, Amazon Linux 2023 with automatic AMI resolution (guide)
• Multi-Architecture: x86_64 and ARM64 with automatic architecture inference
• Custom Templates: Run user-provided scripts at any provisioning phase (guide)
• Multi-Node Clusters: HA Kubernetes clusters with kubeadm (guide)
• Flexible Sources: Install components from packages, git, runfiles, or latest branches (guide)
• Automatic IP Detection: No manual IP configuration needed for AWS (guide)

🚀 Quick Start

See docs/quick-start.md for a full walkthrough.

make build
sudo mv ./bin/holodeck /usr/local/bin/holodeck
holodeck --help

🛠️ Prerequisites

• Go 1.20+
• (For AWS) Valid AWS credentials in your environment
• (For SSH) Reachable host and valid SSH key

See docs/prerequisites.md for details.

⚠️ Important: Kernel Compatibility

When installing NVIDIA drivers, Holodeck requires kernel headers matching your running kernel version. If exact headers are unavailable, Holodeck will attempt to find compatible ones, though this may cause driver compilation issues.

For kernel compatibility details and troubleshooting, see Kernel Compatibility in the prerequisites documentation.

📝 How to Contribute

See docs/contributing/ for full details.

Main Makefile Targets

• make build – Build the holodeck binary
• make test – Run all tests
• make lint – Run linters
• make clean – Remove build artifacts

🧑‍💻 Usage

See docs/commands/ for detailed command documentation and examples.

holodeck --help

Example: Create an environment

holodeck create -f ./examples/v1alpha1_environment.yaml

Example: List environments

holodeck list

Example: Delete an environment

holodeck delete <instance-id>

Example: Clean up AWS VPC resources

holodeck cleanup vpc-12345678

Example: Check status

holodeck status <instance-id>

Example: Dry Run

holodeck dryrun -f ./examples/v1alpha1_environment.yaml

📂 More

• Examples
• Guides

For more information, see the documentation directory.