holodeck

module
v0.2.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 29, 2025 License: Apache-2.0

README ΒΆ

Holodeck

  • Tech preview, under heavy development *

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


πŸ“– Documentation


πŸš€ 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.


πŸ“ 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: Check status
holodeck status <instance-id>
Example: Dry Run
holodeck dryrun -f ./examples/v1alpha1_environment.yaml

πŸ“¦ Supported Cuda-Drivers

See docs/prerequisites.md for the full list and usage.


πŸ“‚ More


For more information, see the docs/ directory.

Directories ΒΆ

Path Synopsis
api
holodeck/v1alpha1
Package v1alpha1 contains API Schema definitions for the holodeck v1alpha1 API group +kubebuilder:object:generate=true +groupName=holodeck.nvidia.com
Package v1alpha1 contains API Schema definitions for the holodeck v1alpha1 API group +kubebuilder:object:generate=true +groupName=holodeck.nvidia.com
cmd
action command
cli command
internal
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL