Skip to content

raids-lab/crater

Repository files navigation

English · 简体中文

Crater logo

Crater

A comprehensive AI development platform for Kubernetes that provides GPU resource management, containerized development environments, and workflow orchestration.

License Docs Backend Build Helm Chart Validate

Documentation · Helm Chart · Backend · Frontend

Jupyter Lab
Jupyter Lab
Ray Job
Ray Job
Monitor
Monitor
Models
Models

Crater is a Kubernetes-based platform that helps teams manage heterogeneous compute resources (e.g., GPUs) and run AI workloads through unified scheduling, development environments, and observability.

Features

  • 🎛️ Intuitive UI: Manage clusters, jobs, and resources through a clean web interface.
  • ⚙️ Intelligent scheduling: Allocate resources based on priority and requirements to improve utilization.
  • 📈 Monitoring & logs: Observe cluster status and troubleshoot with metrics and logs.

Architecture

crater architecture

High-level architecture of Crater and its major components.

Documentation

Deployment guides:

If you want to quickly deploy a basic Crater using Kind, please refer to Minimal Deployment.

If you want to deploy a full Crater in a cluster, please refer to Cluster Deployment Guide.

English versions:

Getting Started

Prerequisites

  • A running Kubernetes cluster
  • kubectl
  • Helm v3

To get started with Crater, you first need to have a running Kubernetes cluster. You can set up a cluster using one of the following methods:

🐳 1. Local Cluster with Kind

Kind (Kubernetes IN Docker) is a lightweight tool for running local Kubernetes clusters using Docker containers.

📖 https://kind.sigs.k8s.io/

🧱 2. Local Cluster with Minikube

Minikube runs a single-node Kubernetes cluster locally, ideal for development and testing.

📖 https://minikube.sigs.k8s.io/

☁️ 3. Production-grade Kubernetes Cluster

For deploying Crater in a production or large-scale test environment, you can use any standard Kubernetes setup.

📖 https://kubernetes.io/docs/setup/

Install via Helm (OCI)

Use the docs above for a full guide. The chart version can be found in charts/crater/Chart.yaml (field version) or GitHub releases.

helm registry login ghcr.io
helm install crater oci://ghcr.io/raids-lab/crater --version <chart-version>

Repository Structure

  • backend/: Backend services
  • frontend/: Web UI
  • backend/internal/storage/: Storage service (integrated in backend module)
  • charts/: Helm charts for deploying Crater
  • website/: Documentation website source
  • grafana-dashboards/: Grafana dashboards used by Crater
  • docs/: Documentation entrypoints and localization resources
  • hack/: Developer tooling and scripts

Contributing

We welcome community contributions. The complete development and contribution specification lives in CONTRIBUTING.md: global rules, environment setup (fork, hooks, unified config), workflow, commit convention, PR description template, and per-module entry points.

Per-module specs:

License

Crater is licensed under the Apache License 2.0. See LICENSE.