Documentation

This section is generated from the Markdown files in the repository docs/ directory so the website and source documentation stay aligned.

Recommended Path

Adoption Signals Adoption Signals This document defines the public adoption signals kruntimes should track after launch. The goal is to … API API Reference kruntimes exposes Kubernetes CRDs and a local Runtime Server gRPC API. Kubernetes APIs All CRDs are … Architecture Architecture kruntimes separates Kubernetes-level capacity management from request-level Run assignment. Components … Benchmarks Performance Benchmarks kruntimes includes an opt-in benchmark harness for measuring scheduler latency, completion … Community Community and Project Governance This page collects the project documents that define how people participate, get help, … Comparison Comparison Guide This guide explains how kruntimes relates to adjacent Kubernetes execution systems. The goal is to help … Compatibility Compatibility Matrix kruntimes is currently a v0.x experimental project with v1alpha1 APIs. This matrix documents the … Configuration Configuration This page summarizes the most common configuration surfaces. Helm Values The platform chart configures: … Custom Runtime Custom Runtime Development Guide Custom Runtimes let you bring a workload-specific execution environment to kruntimes … Demos End-to-End Demos These demos assume you have access to a Kubernetes cluster. The cluster can be a local kind or minikube … Development Development Guide This guide covers local development for contributors. Requirements Go version from go.mod Docker or … Faq FAQ Is kruntimes a Kubernetes scheduler replacement? No. Kubernetes still schedules Runtime Pods. kruntimes schedules … Installation Installation kruntimes is installed with Helm. The current model is cluster-wide platform installation plus … Operations Operations Guide This guide covers day-two operations for the current cluster-wide kruntimes installation model. … Overview Project Overview kruntimes is a Kubernetes-native execution engine that runs serverless functions, CI pipelines, batch … Quickstart Quick Start This guide installs a released kruntimes build on an existing Kubernetes cluster and executes one Bash Run. … Release Release Process kruntimes uses SemVer tags with a leading v, for example v0.1.0. The project is currently v0.x … Roadmap Project Status and Roadmap kruntimes is actively developed as a v0.x experimental project. APIs are v1alpha1 and may … Security Security, Authorization, and Threat Model kruntimes uses Kubernetes namespaces and RBAC as its current administrative … Testing Testing Guide This guide lists the test suites and when to run them. Unit Tests make test Covers Go packages outside … Troubleshooting Troubleshooting This guide covers common failures and the first commands to run. Run Stays Pending Check the Run: … Usage Usage Guide This guide covers the common user workflows for Runtime and Run objects. Create a Runtime A Runtime defines … User Validation Target User Validation Playbook This playbook turns the post-public validation items in Open Source Readiness into a … When to Use When to Use kruntimes kruntimes is a warm execution substrate for Kubernetes. It is useful when a team wants … kruntimes PRD Background: Challenges in Building a Kubernetes-Based Serverless Platform Building a serverless platform on Kubernetes … Open Source Readiness Plan This document tracks the improvements kruntimes needs to complete before the repository is made public. The goal is not …