quick-start.md

Quick Start Guide

This guide will help you get started with Holodeck quickly.

Installation

# Build the binary
make build

# Install to your system (requires sudo)
sudo mv ./bin/holodeck /usr/local/bin/holodeck

Prerequisites

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

See Prerequisites for full details.

Your First Environment

1. Create a basic environment configuration file (e.g., environment.yaml):

apiVersion: holodeck.nvidia.com/v1alpha1
kind: Environment
metadata:
  name: my-first-env
  description: "My first Holodeck environment"
spec:
  provider: aws
  instance:
    type: g4dn.xlarge
    region: us-west-2
    image:
      os: ubuntu-22.04
  kubernetes:
    install: true
    installer: kubeadm
    version: v1.28.5

Tip: The os field automatically resolves the correct AMI for your region and architecture. See the OS Selection Guide for supported operating systems.

1. Create the environment:

holodeck create -f environment.yaml

1. List environments and find your instance ID:

holodeck list

1. Check the status of your environment:

holodeck status <instance-id>

1. When done, delete the environment:

holodeck delete <instance-id>

Next Steps

• Check out the Prerequisites for detailed setup requirements
• Explore the Command Reference for all available commands
• See Examples for more complex configurations
• Read the OS Selection Guide to learn about supported operating systems
• Try Custom Templates to run your own scripts during provisioning