Documentation

Getting Started

Deploy deterministic trust infrastructure in your environment.

Installation

Prerequisites

ValidKernel requires the following:

- Linux (Ubuntu 20.04+, RHEL 8+) or macOS 12+
- 4GB RAM minimum, 8GB recommended
- 10GB disk space
- Network access for cloud deployment (optional)

Install via Package Manager

# Debian/Ubuntu
curl -fsSL https://pkg.validkernel.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/validkernel.gpg
echo "deb [signed-by=/usr/share/keyrings/validkernel.gpg] https://pkg.validkernel.com/apt stable main" | sudo tee /etc/apt/sources.list.d/validkernel.list
sudo apt update && sudo apt install validkernel

# RHEL/CentOS
sudo yum install -y https://pkg.validkernel.com/rpm/validkernel-repo.rpm
sudo yum install validkernel

# macOS
brew tap validkernel/tap
brew install validkernel

Install via Docker

# Pull the official image
docker pull validkernel/kernel:latest

# Run with default configuration
docker run -d \
  --name validkernel \
  -p 8080:8080 \
  -v /path/to/policies:/etc/validkernel/policies \
  validkernel/kernel:latest

Configuration

Basic Configuration

Create a configuration file at /etc/validkernel/config.yaml:

# ValidKernel Configuration
# Document ID: VK-CONFIG-001

kernel:
  mode: enforce          # enforce | audit | permissive
  log_level: info        # debug | info | warn | error
  
validation:
  latency_target: 0.01ms
  deterministic: true
  
audit:
  enabled: true
  output: /var/log/validkernel/audit.log
  format: json
  
policies:
  directory: /etc/validkernel/policies
  reload_interval: 60s

Define Your First Policy

Create a policy file at /etc/validkernel/policies/default.lds:

# L0 Policy Definition
# Authority: Human Governance

policy "default" {
  description = "Default boundary policy"
  
  rule "validate_input" {
    condition = input.size < 1048576  # 1MB max
    action    = allow
  }
  
  rule "deny_unauthorized" {
    condition = !auth.valid
    action    = deny
    log       = true
  }
}

Verification

Check Installation

$ validkernel version
ValidKernel v1.0.0
Kernel: LDS Boundary System
Status: READY

$ validkernel health
Status: HEALTHY
Latency: 0.008ms
Policies: 1 loaded
Mode: enforce

Run Benchmark

$ validkernel benchmark --iterations 1000
Running benchmark...

Results:
  Iterations: 1000
  Mean Latency: 0.009ms
  P99 Latency: 0.012ms
  Determinism: 100%
  Status: PASSED

Next Steps